oracle.dss.bicontext
Interface BIContext

All Superinterfaces:

javax.naming.Context, javax.naming.directory.DirContext

All Known Subinterfaces:

PersistenceManager

All Known Implementing Classes:

MDFolder

public interface BIContext

extends javax.naming.directory.DirContext

The directory service interface for the BI Beans. This interface is used by both the PersistenceManager interface and the MDFolder class of the Metadata Manager.

This interface adds maintenance methods, such as move and copy, to the DirContext interface. It also adds and access control methods.

See Also:

DirContext

Fields inherited from interface javax.naming.directory.DirContext

ADD_ATTRIBUTE, REMOVE_ATTRIBUTE, REPLACE_ATTRIBUTE

Fields inherited from interface javax.naming.Context

APPLET, AUTHORITATIVE, BATCHSIZE, DNS_URL, INITIAL_CONTEXT_FACTORY, LANGUAGE, OBJECT_FACTORIES, PROVIDER_URL, REFERRAL, SECURITY_AUTHENTICATION, SECURITY_CREDENTIALS, SECURITY_PRINCIPAL, SECURITY_PROTOCOL, STATE_FACTORIES, URL_PKG_PREFIXES

Method Summary

void	copy(javax.naming.Name name, javax.naming.directory.DirContext context, javax.naming.Name newName, int mode) Copies an existing context or object.
void	copy(java.lang.String name, javax.naming.directory.DirContext context, java.lang.String newName, int mode) Copies an existing context or object.
Acl	getAcl() Retrieves the access control list for this context.
java.util.Locale	getLocale() Retrieves the locale for this context.
java.lang.Object	lookup(javax.naming.Name name, Persistable persistable) Loads a Persistable object or folder from the repository.
java.lang.Object	lookup(javax.naming.Name name, Persistable persistable, java.util.Hashtable args) Loads a Persistable object or folder from the repository.
java.lang.Object	lookup(java.lang.String name, Persistable persistable) Loads a Persistable object or folder from the repository.
java.lang.Object	lookup(java.lang.String name, Persistable persistable, java.util.Hashtable args) Loads a Persistable object or folder from the repository.
void	move(javax.naming.Name name, javax.naming.directory.DirContext context) Moves an existing context or object.
void	move(java.lang.String name, javax.naming.directory.DirContext context) Moves an existing context or object.
void	refresh() Refreshes the entries in the current folder.
javax.naming.NamingEnumeration	search(javax.naming.Name name, javax.naming.directory.Attributes matchingAttributes, javax.naming.directory.SearchControls searchControl) Searches a folder for objects that have specified attributes.
javax.naming.NamingEnumeration	search(java.lang.String name, javax.naming.directory.Attributes matchingAttributes, javax.naming.directory.SearchControls searchControls) Searches a folder for objects that have specified attributes.
void	setLocale(java.util.Locale locale) Specifies the locale used by this context.

Methods inherited from interface javax.naming.directory.DirContext

bind, bind, createSubcontext, createSubcontext, getAttributes, getAttributes, getAttributes, getAttributes, getSchema, getSchema, getSchemaClassDefinition, getSchemaClassDefinition, modifyAttributes, modifyAttributes, modifyAttributes, modifyAttributes, rebind, rebind, search, search, search, search, search, search, search, search

Methods inherited from interface javax.naming.Context

addToEnvironment, bind, bind, close, composeName, composeName, createSubcontext, createSubcontext, destroySubcontext, destroySubcontext, getEnvironment, getNameInNamespace, getNameParser, getNameParser, list, list, listBindings, listBindings, lookup, lookup, lookupLink, lookupLink, rebind, rebind, removeFromEnvironment, rename, rename, unbind, unbind

Method Detail

refresh

public void refresh()
             throws javax.naming.NamingException

Refreshes the entries in the current folder. This is a way to notify the context to refresh its cache, if it has a cache. Refreshing the cache allows subsequent calls to search, list, and listBinding to reflect the new changes.

Throws:

javax.naming.NamingException - If a naming error occurs.

getAcl

public Acl getAcl()
           throws javax.naming.NamingException

Retrieves the access control list for this context. The access control list is a list of permissions.

Returns:

The access control list for this context.

Throws:

javax.naming.NamingException - If there is a problem with the name.

move

public void move(javax.naming.Name name,
                 javax.naming.directory.DirContext context)
          throws javax.naming.NamingException

Moves an existing context or object.

Parameters:

name - The name of the object to move. The path in name is relative to this context.

context - The context into which to move name.

Throws:

NameAlreadyBoundException - If another object in context is already bound to name.

NameNotFoundException - If the object to be moved cannot be found.

javax.naming.NamingException - If any other naming error occurs.

move

public void move(java.lang.String name,
                 javax.naming.directory.DirContext context)
          throws javax.naming.NamingException

Moves an existing context or object.

Parameters:

name - The name of the object to move. Use a slash (/) to separate folder names. The path is relative to this context.

context - The context into which to move name.

Throws:

NameAlreadyBoundException - If another object in context is already bound to name.

NameNotFoundException - If the object to be moved cannot be found.

javax.naming.NamingException - If any other naming error occurs.

copy

public void copy(javax.naming.Name name,
                 javax.naming.directory.DirContext context,
                 javax.naming.Name newName,
                 int mode)
          throws javax.naming.NamingException

Copies an existing context or object.

Parameters:

name - The name of the object to copy. The path in name is relative to this context.

context - The context into which to copy name.

newName - The new name for the copy of the original object. If you pass null, then the new name will be the same as the old name.

mode - A constant that identifies whether to copy related objects or only name.

Throws:

NameAlreadyBoundException - If another object in context is already bound to name.

NameNotFoundException - If the object to be copied cannot be found.

javax.naming.NamingException - If any other naming error occurs.

See Also:

PSRConstants.NORMAL_COPY, PSRConstants.DEEP_COPY

copy

public void copy(java.lang.String name,
                 javax.naming.directory.DirContext context,
                 java.lang.String newName,
                 int mode)
          throws javax.naming.NamingException

Copies an existing context or object.

Parameters:

name - The name of the object to copy. Use a slash (/) to separate folder names. The path in name is relative to this context.

context - The context into which to copy name.

newName - The new name for the copy of the original object. If you pass null, then the new name will be the same as the old name.

mode - A constant that identifies whether to copy related objects or only name.

Throws:

NameAlreadyBoundException - If another object in context is already bound to name.

NameNotFoundException - If the object to be copied cannot be found.

javax.naming.NamingException - If any other naming error occurs.

See Also:

PSRConstants.NORMAL_COPY, PSRConstants.DEEP_COPY

search

public javax.naming.NamingEnumeration search(java.lang.String name,
                                             javax.naming.directory.Attributes matchingAttributes,
                                             javax.naming.directory.SearchControls searchControls)
                                      throws javax.naming.NamingException

Searches a folder for objects that have specified attributes. This method retrieves specified attributes of the found objects.

Parameters:

name - The name of the folder to search.

matchingAttributes - The attributes of the objects that you want to find.

searchControl - The search controls that control the search. It can be null.

Returns:

An enumeration of SearchResult objects. The search results contain the attributes that you requested in attributesToReturn, and the name of the object, relative to name.

Throws:

javax.naming.NamingException - If a naming error occurs.

See Also:

javax.naming.directory.DirContext#search(Name, Attributes, SearchControls)

search

public javax.naming.NamingEnumeration search(javax.naming.Name name,
                                             javax.naming.directory.Attributes matchingAttributes,
                                             javax.naming.directory.SearchControls searchControl)
                                      throws javax.naming.NamingException

Searches a folder for objects that have specified attributes. This method retrieves specified attributes of the found objects.

Parameters:

name - The name of the folder to search.

matchingAttributes - The attributes of the objects that you want to find.

searchControl - The search controls that control the search. It can be null.

Returns:

An enumeration of SearchResult objects. The search results contain the attributes that you requested in attributesToReturn, and the name of the object, relative to name.

Throws:

javax.naming.NamingException - If a naming error occurs.

See Also:

javax.naming.directory.DirContext#search(String, Attributes, SearchControls)

lookup

public java.lang.Object lookup(java.lang.String name,
Persistable persistable)
                        throws javax.naming.NamingException

Loads a Persistable object or folder from the repository.

Parameters:

name - The name of the object to be load. Do not pass null.

Returns:

The requested object or folder. The object implements the Persistable interface.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - if any other naming error occurs.

See Also:

Context.lookup(String), Persistable

lookup

public java.lang.Object lookup(javax.naming.Name name,
Persistable persistable)
                        throws javax.naming.NamingException

Loads a Persistable object or folder from the repository.

Parameters:

name - The name of the object to be load. Do not pass null.

Returns:

The requested object or folder. The object implements the Persistable interface.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - if any other naming error occurs.

See Also:

Context.lookup(String), Persistable

lookup

public java.lang.Object lookup(java.lang.String name,
Persistable persistable,
                               java.util.Hashtable args)
                        throws javax.naming.NamingException

Loads a Persistable object or folder from the repository.

Parameters:

name - The name of the object to be load. Do not pass null.

Returns:

The requested object or folder. The object implements the Persistable interface.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - if any other naming error occurs.

See Also:

Context.lookup(String), Persistable

lookup

public java.lang.Object lookup(javax.naming.Name name,
Persistable persistable,
                               java.util.Hashtable args)
                        throws javax.naming.NamingException

Loads a Persistable object or folder from the repository.

Parameters:

name - The name of the object to be load. Do not pass null.

Returns:

The requested object or folder. The object implements the Persistable interface.

Throws:

BIInvalidNameException - If name is null or empty.

BINameNotFoundException - If the object or folder cannot be found.

BINamingException - if any other naming error occurs.

See Also:

Context.lookup(String), Persistable

getLocale

public java.util.Locale getLocale()

Retrieves the locale for this context.

Returns:

The locale setting for this context, or the the system default locale, if not locale has been explicitly set.

setLocale

public void setLocale(java.util.Locale locale)

Specifies the locale used by this context. The scope of this setting is up to the implementor. It may apply to all context in the system, or only to this context. Setting the locale updates all PersistenceManager instances with the new locale setting.

Parameters:

locale - The locale to set.