Overview  Package   Class  Tree  Deprecated  Index  Help 

Oracle™ Business Intelligence Beans Java API Reference
Release 10g (9.0.4)
Part number B12159_01

 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD

oracle.dss.persistence.persistencemanager.client
Class PersistenceManagerImpl

java.lang.Object
  |
  +--oracle.dss.persistence.persistencemanager.client.PersistenceManagerImpl
All Implemented Interfaces:
BIContext, javax.naming.Context, javax.naming.directory.DirContext, ErrorHandlerCallback, PersistenceManager
public class PersistenceManagerImpl
extends java.lang.Object
implements PersistenceManager, ErrorHandlerCallback

The client-tier implementation of a persistence manager. A PersistenceManagerImpl represents a directory context. A directory context is a directory-like object in a storage system. The default storage system for this PersistenceManagerImpl is an Oracle8i database.

When you specify names to methods in this class, the names are always relative to this context, unless specified otherwise. Use forward slashes to separate folders from subfolders. For example, if object MyObject is stored in a folder MyFolder, and MyFolder is a subfolder of this folder, then the String name for MyObject is MyFolder/MyObject.

Valid attributes for folders are defined in oracle.dss.persistence.PSRConstants and in oracle.dss.util.Persistence.PersistableConstants.

You should not need to construct a PersistenceManagerImpl for most folders. Instead, instantiate an InitialPersistenceManager to create the root folder. Then call the createSubcontext of the InitialPersistenceManager to create subfolders in the root folder. createSubcontext returns a PersistenceManagerImpl. To create more subfolders, call createSubcontext of parent folders.

See Also:
createSubcontext(javax.naming.Name), InitialPersistenceManager, PersistableConstants, PSRConstants

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 addErrorHandler(ErrorHandler eh)
          Adds a single error handler to this PersistenceManagerImpl.
 java.lang.Object addToEnvironment(java.lang.String propName, java.lang.Object propValue)
          Adds a property to the current environment setting.
 void associate(javax.naming.Name relativeSourceName, javax.naming.Name[] fullNameOfTarget, javax.naming.directory.Attribute[] identifiers)
          Associates an object with a set of objects.
 void associate(javax.naming.Name relativeSourceName, javax.naming.Name fullNameOfTarget, javax.naming.directory.Attribute identifier)
          Associates an object with another object.
 void associate(java.lang.String relativeSourceName, java.lang.String[] fullNameOfTarget, javax.naming.directory.Attribute[] identifier)
          Associates an object with a set of objects.
 void associate(java.lang.String relativeSourceName, java.lang.String fullNameOfTarget, javax.naming.directory.Attribute identifier)
          Associates an object with another object.
 void bind(javax.naming.Name name, java.lang.Object object)
          Saves a Persistable object to the repository.
 void bind(javax.naming.Name name, java.lang.Object object, javax.naming.directory.Attributes attrs)
          Saves a Persistable object to the repository.
 void bind(java.lang.String name, java.lang.Object object)
          Saves a Persistable object to the repository.
 void bind(java.lang.String name, java.lang.Object object, javax.naming.directory.Attributes attrs)
          Saves a Persistable object to the repository.
 void close()
          Closes this context and releases all the resources that it held.
 javax.naming.Name composeName(javax.naming.Name name, javax.naming.Name prefix)
          Combines parts of a path name to a single Name.
 java.lang.String composeName(java.lang.String name, java.lang.String prefix)
          Combines parts of a path name to a single Name.
 void copy(javax.naming.Name name, javax.naming.directory.DirContext context, javax.naming.Name newName, int mode)
          Copies an object or a folder to another folder.
 void copy(java.lang.String name, javax.naming.directory.DirContext context, java.lang.String newName, int mode)
          Copies an object or a folder to another folder.
 javax.naming.Context createSubcontext(javax.naming.Name name)
          Creates a PersistenceManager that represents a folder.
 javax.naming.directory.DirContext createSubcontext(javax.naming.Name name, javax.naming.directory.Attributes attrs)
          Creates a PersistenceManager that represents a folder.
 javax.naming.Context createSubcontext(java.lang.String name)
          Creates a PersistenceManager that represents a folder.
 javax.naming.directory.DirContext createSubcontext(java.lang.String name, javax.naming.directory.Attributes attrs)
          Creates a PersistenceManager that represents a folder.
 void destroySubcontext(javax.naming.Name name)
          Removes a folder from the repository.
 void destroySubcontext(java.lang.String name)
          Removes a folder from the repository.
 void dissociate(javax.naming.Name relativeSourceName, javax.naming.directory.Attribute identifier)
          Dissociates an object from other objects.
 void dissociate(javax.naming.Name relativeSourceName, javax.naming.directory.Attribute[] identifiers)
          Dissociates an object from other objects.
 void dissociate(java.lang.String relativeSourceName, javax.naming.directory.Attribute identifier)
          Dissociates an object from other objects.
 void dissociate(java.lang.String relativeSourceName, javax.naming.directory.Attribute[] identifiers)
          Dissociates an object from other objects.
 boolean exportSubcontext(javax.naming.directory.Attributes filterAttrs, java.lang.String exportFileName)
          Exports the current folder to an external source.
 boolean exportSubcontext(java.lang.String fileName, TransferControl control)
          Exports contents of the current folder to a file.
 Acl getAcl()
          Retrieves the access control list of this folder.
 java.lang.Object getAssociateObject(javax.naming.Name relativeSourceName, javax.naming.directory.Attribute identifier)
          Retrieve the associated object specified by the identifier.
 java.lang.Object getAssociateObject(java.lang.String relativeSourceName, javax.naming.directory.Attribute identifier)
          Retrieve the associated object specified by the identifier.
 javax.naming.directory.Attributes getAttributes(javax.naming.Name name)
          Retrieves all the attributes for an object.
 javax.naming.directory.Attributes getAttributes(javax.naming.Name name, java.lang.String[] attrIds)
          Retrieves the specified attributes for an object.
 javax.naming.directory.Attributes getAttributes(java.lang.String name)
          Retrieves all the attributes for an object.
 javax.naming.directory.Attributes getAttributes(java.lang.String name, java.lang.String[] attrIds)
          Retrieves the specified attributes for an object.
 java.util.Hashtable getEnvironment()
          Retrieves the environment for this context.
 java.util.Locale getLocale()
          Retrieves the locale for the persistence service.
 javax.naming.NameParser getNameParser(javax.naming.Name name)
          Retrieves the name parser for a folder.
 javax.naming.NameParser getNameParser(java.lang.String name)
          Retrieves the name parser for a folder.
 javax.naming.directory.DirContext getSchema(javax.naming.Name name)
          Retrieves the schema of an object.
 javax.naming.directory.DirContext getSchema(java.lang.String name)
          Retrieves the schema of an object.
 javax.naming.directory.DirContext getSchemaClassDefinition(javax.naming.Name name)
          Retrieves the schema definition of an object.
 javax.naming.directory.DirContext getSchemaClassDefinition(java.lang.String name)
          Retrieves the schema definition of an object.
 boolean importSubcontext(java.lang.String importFileName)
          Imports a folder from an external source.
 boolean importSubcontext(java.lang.String fileName, TransferControl control)
          Imports the content of a folder from a file.
 javax.naming.NamingEnumeration list(javax.naming.Name name)
          Enumerates the names and class names of the objects in a folder.
 javax.naming.NamingEnumeration list(java.lang.String name)
          Enumerates the names and class names of the objects in a folder.
 java.util.Vector listAssociates(javax.naming.Name relativeSourceName, java.lang.String[] attrsToReturn, javax.naming.directory.Attribute identifier)
          Returns a list of associate objects specified by the identifier.
 java.util.Vector listAssociates(java.lang.String relativeSourceName, java.lang.String[] attrsToReturn, javax.naming.directory.Attribute identifier)
          Returns a list of associate objects specified by the identifier.
 javax.naming.NamingEnumeration listBindings(javax.naming.Name name)
          Enumerates the objects in a folder, with their names and class names.
 javax.naming.NamingEnumeration listBindings(java.lang.String name)
          Enumerates the objects in a folder, with their names and class names.
 java.util.Vector listReferringAssociates(javax.naming.Name relativeSourceName, java.lang.String[] attrsToReturn, javax.naming.directory.Attribute identifier)
          Returns a list of associate objects referred to or referred by the source object.
 java.util.Vector listReferringAssociates(java.lang.String relativeSourceName, java.lang.String[] attrsToReturn, javax.naming.directory.Attribute identifier)
          Returns a list of associate objects referred to or referred by the source object.
 java.lang.Object lookup(javax.naming.Name name)
          Loads a Persistable object or folder from the repository.
 java.lang.Object lookup(javax.naming.Name name, Persistable persistable)
          Updates a Persistable object or folder from the repository.
 java.lang.Object lookup(javax.naming.Name name, Persistable persistable, java.util.Hashtable args)
          Updates a Persistable object or folder from the repository.
 java.lang.Object lookup(java.lang.String name)
          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)
          Updates a Persistable object or folder from the repository.
 java.lang.Object lookupDefinition(javax.naming.Name name)
          Retrieves the StateAgent of an object, without actually instantiating the object itself.
 java.lang.Object lookupDefinition(java.lang.String name)
          Retrieves the StateAgent of an object, without actually instantiating the object itself.
 java.lang.Object lookupLink(javax.naming.Name name)
          Loads a Persistable object or folder from the repository.
 java.lang.Object lookupLink(java.lang.String name)
          Loads a Persistable object or folder from the repository.
 void modifyAttributes(javax.naming.Name name, int mod_op, javax.naming.directory.Attributes attrs)
          Modifies attributes for an object.
 void modifyAttributes(javax.naming.Name name, javax.naming.directory.ModificationItem[] mods)
          Modifies attributes for an object.
 void modifyAttributes(java.lang.String name, int mod_op, javax.naming.directory.Attributes attrs)
          Modifies attributes for an object.
 void modifyAttributes(java.lang.String name, javax.naming.directory.ModificationItem[] mods)
          Modifies attributes for an object.
 void move(javax.naming.Name name, javax.naming.directory.DirContext context)
          Moves an object or a folder to another folder.
 void move(java.lang.String name, javax.naming.directory.DirContext context)
          Moves an object or a folder to another folder.
 void rebind(javax.naming.Name name, java.lang.Object object)
          Saves a Persistable object to a name that is already in the repository.
 void rebind(javax.naming.Name name, java.lang.Object object, javax.naming.directory.Attributes attrs)
          Saves a Persistable object to a name that is already in the repository.
 void rebind(java.lang.String name, java.lang.Object object)
          Saves a Persistable object to a name that is already in the repository.
 void rebind(java.lang.String name, java.lang.Object object, javax.naming.directory.Attributes attrs)
          Saves a Persistable object to a name that is already in the repository.
 void removeErrorHandler()
          Removes a customized error handler for this persistence manager.
 java.lang.Object removeFromEnvironment(java.lang.String propName)
          Removes a property from the environment setting.
 void rename(javax.naming.Name oldName, javax.naming.Name newName)
          Renames a Persistable object in the repository in this context.
 void rename(java.lang.String oldName, java.lang.String newName)
          Renames a Persistable object in the repository in this context.
 javax.naming.NamingEnumeration search(javax.naming.Name name, javax.naming.directory.Attributes matchingAttributes)
          Searches a folder for objects that have specified attributes.
 javax.naming.NamingEnumeration search(javax.naming.Name name, javax.naming.directory.Attributes matchingAttributes, javax.naming.directory.SearchControls searchControls)
          Searches a folder for objects that have specified attributes, using the specified search scope.
 javax.naming.NamingEnumeration search(javax.naming.Name name, javax.naming.directory.Attributes matchingAttributes, java.lang.String[] attributesToReturn)
          Searches a folder for objects that have specified attributes.
 javax.naming.NamingEnumeration search(java.lang.String name, javax.naming.directory.Attributes matchingAttributes)
          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, using the specified search scope.
 javax.naming.NamingEnumeration search(java.lang.String name, javax.naming.directory.Attributes matchingAttributes, java.lang.String[] attributesToReturn)
          Searches a folder for objects that have specified attributes.
 void setLocale(java.util.Locale locale)
          Specifies the locale that the persistence service uses.
 void unbind(javax.naming.Name name)
          Removes a Persistable object from the repository.
 void unbind(java.lang.String name)
          Removes a Persistable object from the repository.

 

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

 

Methods inherited from interface oracle.dss.bicontext.BIContext
refresh

 

Methods inherited from interface javax.naming.directory.DirContext
search, search, search, search

 

Methods inherited from interface javax.naming.Context
getNameInNamespace

 

Method Detail

addErrorHandler

public void addErrorHandler(ErrorHandler eh)
Adds a single error handler to this PersistenceManagerImpl. The error handler will be called when the persistence manager traps an error from another part of the system.

Use this method to install your own error handler.

Specified by:
addErrorHandler in interface ErrorHandlerCallback
Parameters:
eh - The error handler to use.

removeErrorHandler

public void removeErrorHandler()
Removes a customized error handler for this persistence manager. This method replaces the current error handler with a default error handler. The default error handler prints information to the console.
Specified by:
removeErrorHandler in interface ErrorHandlerCallback

lookup

public java.lang.Object lookup(javax.naming.Name name)
                        throws javax.naming.NamingException
Loads a Persistable object or folder from the repository.
Specified by:
lookup in interface javax.naming.Context
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:
lookup(String), Persistable

lookup

public java.lang.Object lookup(java.lang.String name)
                        throws javax.naming.NamingException
Loads a Persistable object or folder from the repository.
Specified by:
lookup in interface javax.naming.Context
Parameters:
name - The name of the object to be load. The object must implement the Persistable interface. Do not pass null.
Returns:
The requested object or folder.
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:
lookup(String), Persistable

bind

public void bind(javax.naming.Name name,
                 java.lang.Object object)
          throws javax.naming.NamingException
Saves a Persistable object to the repository. This method binds name to object, so that object can be found later.
Specified by:
bind in interface javax.naming.Context
Parameters:
name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.
object - The object to save. The object must be of type Persistable.
Throws:
BIInvalidNameException - If name is null or empty.
BINameAlreadyBoundException - If another object is already bound to name. Call rebind to replace a binding.
BINoPermissionException - If the caller does not have permission to save objects to this context.
BINamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface. Also throws BINamingException if you try to use this method to create a folder. Call createSubcontext instead.
See Also:
bind(String, Object), createSubcontext(javax.naming.Name), rebind(javax.naming.Name, java.lang.Object), Persistable

bind

public void bind(java.lang.String name,
                 java.lang.Object object)
          throws javax.naming.NamingException
Saves a Persistable object to the repository. This method binds name to object, so that object can be found later.
Specified by:
bind in interface javax.naming.Context
Parameters:
name - The path name of the object that this method saves. Do not pass null or an empty String. The path that you specify must exist. This method does not create intermediate subcontexts.
object - The object to save. The object must be of type Persistable.
Throws:
BIInvalidNameException - If name is null or empty.
BINameAlreadyBoundException - If another object is already bound to name. Call rebind to replace a binding.
BINoPermissionException - If the caller does not have permission to save objects to this context.
BINamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface. Also throws BINamingException if you try to use this method to create a folder. Call createSubcontext instead.
See Also:
bind(Name, Object), createSubcontext(javax.naming.Name), rebind(javax.naming.Name, java.lang.Object), Persistable

rebind

public void rebind(javax.naming.Name name,
                   java.lang.Object object)
            throws javax.naming.NamingException
Saves a Persistable object to a name that is already in the repository. This method binds an object to a name that is already bound, replacing the existing binding. If the name is not already bound, then this method binds the object to the name, just as the bind method does.
Specified by:
rebind in interface javax.naming.Context
Parameters:
name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.
object - The object to save. The object must be of type Persistable.
Throws:
BIInvalidNameException - If name is null or empty.
BINamingException - If object is a PersistenceManagerImpl. Call createSubcontext to create a folder.
BINoPermissionException - If the caller does not have permission to save objects to this context.
javax.naming.NamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface.
See Also:
rebind(String, Object)

rebind

public void rebind(java.lang.String name,
                   java.lang.Object object)
            throws javax.naming.NamingException
Saves a Persistable object to a name that is already in the repository. This method binds an object to a name that is already bound, replacing the existing binding. If the name is not already bound, then this method binds the object to the name, just as the bind method does.
Specified by:
rebind in interface javax.naming.Context
Parameters:
name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.
object - The object to save. The object must be of type Persistable.
Throws:
BIInvalidNameException - If name is null or empty.
BINamingException - If object is a PersistenceManagerImpl. Call createSubcontext to create a folder.
BINoPermissionException - If the caller does not have permission to save objects to this context.
javax.naming.NamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface.
See Also:
rebind(Name, Object)

unbind

public void unbind(javax.naming.Name name)
            throws javax.naming.NamingException
Removes a Persistable object from the repository. This method removes the binding of the object.
Specified by:
unbind in interface javax.naming.Context
Parameters:
name - The name of the object to remove.
Throws:
BINameNotFoundException - If the named object is not found in the repository.
BIInvalidNameException - If name is null or empty.
BINamingException - If any other naming error occurs.
See Also:
unbind(String)

unbind

public void unbind(java.lang.String name)
            throws javax.naming.NamingException
Removes a Persistable object from the repository. This method removes the binding of the object.
Specified by:
unbind in interface javax.naming.Context
Parameters:
name - The name of the object to remove.
Throws:
BINameNotFoundException - If the named object is not found in the repository.
BIInvalidNameException - If name is null or empty.
BINamingException - If any other naming error occurs.
See Also:
unbind(Name)

rename

public void rename(javax.naming.Name oldName,
                   javax.naming.Name newName)
            throws javax.naming.NamingException
Renames a Persistable object in the repository in this context. The oldName and the newName arguments must both specify the same context. To move an object from one folder to another, use the move method.
Specified by:
rename in interface javax.naming.Context
Parameters:
oldName - The current name of an existing object or folder. Do not pass null or an empty Name.
newName - The new name to assign to this object or folder. Do not pass null or an empty Name.
Throws:
BIInvalidNameException - If name is null or empty.
BINameNotFoundException - If oldName cannot be found in this context.
BINameAlreadyBoundException - If newName is already bound to an object.
BINoPermissionException - If the caller does not have permission to rename objects in this context.
BINamingException - If any other naming error occurs.
See Also:
rename(String, String)

rename

public void rename(java.lang.String oldName,
                   java.lang.String newName)
            throws javax.naming.NamingException
Renames a Persistable object in the repository in this context. The oldName and the newName arguments must both specify the same context. To move an object from one folder to another, use the move method.
Specified by:
rename in interface javax.naming.Context
Parameters:
oldName - The current name of an existing object or folder. Do not pass null or an empty Name.
newName - The new name to assign to this object or folder. Do not pass null or an empty Name.
Throws:
BIInvalidNameException - If name is null or empty.
BINameNotFoundException - If oldName cannot be found in this context.
BINameAlreadyBoundException - If newName is already bound to an object.
BINoPermissionException - If the caller does not have permission to rename objects in this context.
BINamingException - If any other naming error occurs.
See Also:
rename(Name, Name)

list

public javax.naming.NamingEnumeration list(javax.naming.Name name)
                                    throws javax.naming.NamingException
Enumerates the names and class names of the objects in a folder. This method returns an enumeration of names and class names of the objects in a specified folder. If you want access to the objects, call listBindings.
Specified by:
list in interface javax.naming.Context
Parameters:
name - The name of the folder whose contents you want. Do not pass null. To specify the current folder, pass an empty Name.
Returns:
An enumeration of NameClassPair objects, one for each object in the folder. Each NameClassPair contains the name and the class name of an object.
Throws:
BIInvalidNameException - If name is null.
BINamingException - If any other naming error occurs.
See Also:
listBindings(javax.naming.Name), list(String), NameClassPair

list

public javax.naming.NamingEnumeration list(java.lang.String name)
                                    throws javax.naming.NamingException
Enumerates the names and class names of the objects in a folder. This method returns an enumeration of names and class names of the objects in a specified folder. If you want access to the objects, call listBindings.
Specified by:
list in interface javax.naming.Context
Parameters:
name - The name of the folder whose contents you want. Do not pass null. To specify the current folder, pass an empty String.
Returns:
An enumeration of NameClassPair objects, one for each object in the folder. Each NameClassPair contains the name and the class name of an object.
Throws:
BIInvalidNameException - If name is null.
BINamingException - If any other naming error occurs.
See Also:
listBindings(javax.naming.Name), list(Name), NameClassPair

listBindings

public javax.naming.NamingEnumeration listBindings(javax.naming.Name name)
                                            throws javax.naming.NamingException
Enumerates the objects in a folder, with their names and class names. If you do not need access to the objects, call list.
Specified by:
listBindings in interface javax.naming.Context
Parameters:
name - The name of the folder whose contents you want. Do not pass null. To specify the current folder, pass an empty Name.
Returns:
An enumeration of Binding objects, one for each object in the folder. Each Binding contains the name of an object, its class name, and the object itself.
Throws:
BIInvalidNameException - if name is null.
BINamingException - If any other naming error occurs.
See Also:
list(javax.naming.Name), listBindings(String), Binding

listBindings

public javax.naming.NamingEnumeration listBindings(java.lang.String name)
                                            throws javax.naming.NamingException
Enumerates the objects in a folder, with their names and class names. If you do not need access to the objects, call list.
Specified by:
listBindings in interface javax.naming.Context
Parameters:
name - The name of the folder whose contents you want. Do not pass null. To specify the current folder, pass an empty String.
Returns:
An enumeration of Binding objects, one for each object in the folder. Each Binding contains the name of an object, its class name, and the object itself.
Throws:
BIInvalidNameException - if name is null.
BINamingException - If any other naming error occurs.
See Also:
list(javax.naming.Name), listBindings(Name), Binding

destroySubcontext

public void destroySubcontext(javax.naming.Name name)
                       throws javax.naming.NamingException
Removes a folder from the repository.
Specified by:
destroySubcontext in interface javax.naming.Context
Parameters:
name - The name of the folder to remove. Do not pass null or an empty Name.
Throws:
BIInvalidNameException - If name is null or empty.
BINameNotFoundException - If name is not found.
BINoPermissionException - If the caller does not have the level of privilege necessary to remove the folder. You must have permission to all folders in the path.
BINamingException - If any other naming error occurs.
See Also:
destroySubcontext(String)

destroySubcontext

public void destroySubcontext(java.lang.String name)
                       throws javax.naming.NamingException
Removes a folder from the repository.
Specified by:
destroySubcontext in interface javax.naming.Context
Parameters:
name - The name of the folder to remove. Do not pass null or an empty Name.
Throws:
BINoPermissionException - If the caller does not have the level of privilege necessary to remove the folder. You must have permission to all folders in the path.
BINameNotFoundException - If name is not found.
BINamingException - If any other naming error occurs.
See Also:
destroySubcontext(String)

createSubcontext

public javax.naming.Context createSubcontext(javax.naming.Name name)
                                      throws javax.naming.NamingException
Creates a PersistenceManager that represents a folder.
Specified by:
createSubcontext in interface javax.naming.Context
Parameters:
name - The name for the folder to create. Do not pass null or an empty Name.
Returns:
The PersistenceManager for the new folder.
Throws:
BIInvalidNameException - If name is null or empty.
BINameAlreadyBoundException - If another object is already bound to name.
BINoPermissionException - If the caller does not have permission to create folders in this context.
javax.naming.NamingException - If any other naming error occurs.
See Also:
createSubcontext(String)

createSubcontext

public javax.naming.Context createSubcontext(java.lang.String name)
                                      throws javax.naming.NamingException
Creates a PersistenceManager that represents a folder.
Specified by:
createSubcontext in interface javax.naming.Context
Parameters:
name - The name for the folder to create. Do not pass null or an empty Name.
Returns:
The PersistenceManager for the new folder.
Throws:
BIInvalidNameException - If name is null or empty.
BINameAlreadyBoundException - If another object is already bound to name.
BINoPermissionException - If the caller does not have permission to create folders in this context.
javax.naming.NamingException - If any other naming error occurs.
See Also:
createSubcontext(Name)

lookupLink

public java.lang.Object lookupLink(javax.naming.Name name)
                            throws javax.naming.NamingException
Loads a Persistable object or folder from the repository. Currently, this method simply calls the lookup method.
Specified by:
lookupLink in interface javax.naming.Context
Parameters:
name - The name of the object to be load. The object must implement the Persistable interface. Do not pass null.
Returns:
The requested object or folder.
Throws:
BINameNotFoundException - If the object or folder cannot be found.
BINamingException - if any other naming error occurs.
See Also:
lookupLink(Name), Persistable

lookupLink

public java.lang.Object lookupLink(java.lang.String name)
                            throws javax.naming.NamingException
Loads a Persistable object or folder from the repository. Currently, this method simply calls the lookup method.
Specified by:
lookupLink in interface javax.naming.Context
Parameters:
name - The name of the object to be load. The object must implement the Persistable interface. Do not pass null.
Returns:
The requested object or folder.
Throws:
BINameNotFoundException - If the object or folder cannot be found.
BINamingException - if any other naming error occurs.
See Also:
lookupLink(String), Persistable

getNameParser

public javax.naming.NameParser getNameParser(javax.naming.Name name)
                                      throws javax.naming.NamingException
Retrieves the name parser for a folder.
Specified by:
getNameParser in interface javax.naming.Context
Parameters:
name - The name of the folder for which to get the parser. Currently, all folders uses the same name parser, so you can pass the name of any context.
Returns:
The name parser for the specified folder.
Throws:
javax.naming.NamingException - If a naming error occurs.
See Also:
getNameParser(String)

getNameParser

public javax.naming.NameParser getNameParser(java.lang.String name)
                                      throws javax.naming.NamingException
Retrieves the name parser for a folder.
Specified by:
getNameParser in interface javax.naming.Context
Parameters:
name - The name of the folder for which to get the parser. Currently, all folders uses the same name parser, so you can pass the name of any context.
Returns:
The name parser for the specified folder.
Throws:
javax.naming.NamingException - If a naming error occurs.
See Also:
getNameParser(Name)

composeName

public javax.naming.Name composeName(javax.naming.Name name,
                                     javax.naming.Name prefix)
                              throws javax.naming.NamingException
Combines parts of a path name to a single Name. Normally, you use this method to combine the name of an object relative to this context with the name of this context, to create a full path name.
Specified by:
composeName in interface javax.naming.Context
Parameters:
name - The name of an object in this context or one of its subcontexts.
prefix - The name of this context, as it relates to one of its ancestors. Do not pass null.
Returns:
The name that is composed from prefix and name.
Throws:
InvalidNameException - If name is not a valid name, or if the resulting name is not valid.
javax.naming.NamingException - If any other naming error occurs.
See Also:
composeName(String, String)

composeName

public java.lang.String composeName(java.lang.String name,
                                    java.lang.String prefix)
                             throws javax.naming.NamingException
Combines parts of a path name to a single Name. Normally, you use this method to combine the name of an object relative to this context with the name of this context, to create a full path name.
Specified by:
composeName in interface javax.naming.Context
Parameters:
name - The name of an object in this context or one of its subcontexts. Do not pass null.
prefix - The name of this context, as it relates to one of its ancestors. Do not pass null.
Returns:
The name that is composed from prefix and name.
Throws:
InvalidNameException - If name is not a valid name, or if the resulting name is not valid.
javax.naming.NamingException - If any other naming error occurs.
See Also:
composeName(Name, Name)

addToEnvironment

public java.lang.Object addToEnvironment(java.lang.String propName,
                                         java.lang.Object propValue)
                                  throws javax.naming.NamingException
Adds a property to the current environment setting. If the property already exists, then this method replaces the existing property and returns the replaced property.
Specified by:
addToEnvironment in interface javax.naming.Context
Parameters:
propName - The name of the property to add. Do not pass null.
propValue - The value of the property to add. Do not pass null.
Returns:
The name of the replaced property, if one exists. Otherwise, returns null.
Throws:
javax.naming.NamingException - If a naming error occurs.

removeFromEnvironment

public java.lang.Object removeFromEnvironment(java.lang.String propName)
                                       throws javax.naming.NamingException
Removes a property from the environment setting.
Specified by:
removeFromEnvironment in interface javax.naming.Context
Parameters:
propName - The property to remove. Do not pass null.
Returns:
The value that was stored for the removed property, or null.
Throws:
javax.naming.NamingException - If a naming error occurs.

getEnvironment

public java.util.Hashtable getEnvironment()
                                   throws javax.naming.NamingException
Retrieves the environment for this context. This method returns a copy of the environment Hashtable. Changes you make to the returned Hashtable are not reflected in the original environment. To modify the environment, call addToEnvironment or removeFromEnvironment.
Specified by:
getEnvironment in interface javax.naming.Context
Returns:
A copy of the environment settings for this context.
Throws:
javax.naming.NamingException - If a naming error occurs.
See Also:
addToEnvironment(java.lang.String, java.lang.Object), removeFromEnvironment(java.lang.String)

close

public void close()
           throws javax.naming.NamingException
Closes this context and releases all the resources that it held.
Specified by:
close in interface javax.naming.Context
Throws:
javax.naming.NamingException - If a naming error occurs.

getAttributes

public javax.naming.directory.Attributes getAttributes(javax.naming.Name name)
                                                throws javax.naming.NamingException
Retrieves all the attributes for an object.
Specified by:
getAttributes in interface javax.naming.directory.DirContext
Parameters:
name - The name of the object that you want attributes for. Do not pass null.
Returns:
The attributes for name.
Throws:
BIInvalidNameException - If name is null or empty.
BINoPermissionException - If name is the root folder.
javax.naming.NamingException - If any other naming error occurs.
See Also:
getAttributes(String), PSRConstants, PersistableAttributes

getAttributes

public javax.naming.directory.Attributes getAttributes(java.lang.String name)
                                                throws javax.naming.NamingException
Retrieves all the attributes for an object.
Specified by:
getAttributes in interface javax.naming.directory.DirContext
Parameters:
name - The name of the object that you want attributes for. Do not pass null.
Returns:
The attributes for name.
Throws:
BIInvalidNameException - If name is null or empty.
BINoPermissionException - If name is in the root folder.
BINamingException - If any other naming error occurs.
See Also:
getAttributes(Name)

getAttributes

public javax.naming.directory.Attributes getAttributes(javax.naming.Name name,
                                                       java.lang.String[] attrIds)
                                                throws javax.naming.NamingException
Retrieves the specified attributes for an object.
Specified by:
getAttributes in interface javax.naming.directory.DirContext
Parameters:
name - The name of the object that you want attributes for. Do not pass null.
attrIds - The attributes that you want to retrieve. To retrieve all of the attributes, pass null. If you pass an empty array, then this method returns null.
Returns:
The requested attributes for name.
Throws:
BIInvalidNameException - If name is null or empty.
BINoPermissionException - If name is in the root folder.
BIAttributeModificationException - If the attribute does not exist.
BINamingException - If any other naming error occurs.
See Also:
getAttributes(String, String[])

getAttributes

public javax.naming.directory.Attributes getAttributes(java.lang.String name,
                                                       java.lang.String[] attrIds)
                                                throws javax.naming.NamingException
Retrieves the specified attributes for an object.
Specified by:
getAttributes in interface javax.naming.directory.DirContext
Parameters:
name - The name of the object that you want attributes for. Do not pass null.
attrIds - The attributes that you want to retrieve. To retrieve all of the attributes, pass null. If you pass an empty array, then this method returns null.
Returns:
The requested attributes for name.
Throws:
BIInvalidNameException - If name is null or empty.
BINoPermissionException - If name is in the root folder.
BIAttributeModificationException - If the attribute does not exist.
BINamingException - If any other naming error occurs.
See Also:
getAttributes(Name, String[])

modifyAttributes

public void modifyAttributes(javax.naming.Name name,
                             int mod_op,
                             javax.naming.directory.Attributes attrs)
                      throws javax.naming.NamingException
Modifies attributes for an object. Use this method when you want to use the same modification operation on multiple attributes.
Specified by:
modifyAttributes in interface javax.naming.directory.DirContext
Parameters:
name - The name of the object whose attributes you want to set. Do not pass null.
mod_op - A constant that identifies the modification that you want to make. This implementation supports only javax.naming.directory.DirContext.REPLACE_ATTRIBUTE. If you pass any other value, this method ignores the value and logs a message to the error handler.
attrs - A list of attributes that you want to modify.
Throws:
BIInvalidNameException - If name is null or empty.
BINoPermissionException - If name is in the root folder.
BINamingException - If any other naming error occurs.
See Also:
modifyAttributes(String, int, Attributes), DirContext.ADD_ATTRIBUTE, DirContext.REMOVE_ATTRIBUTE, DirContext.REPLACE_ATTRIBUTE

modifyAttributes

public void modifyAttributes(java.lang.String name,
                             int mod_op,
                             javax.naming.directory.Attributes attrs)
                      throws javax.naming.NamingException
Modifies attributes for an object. Use this method when you want to use the same modification operation on multiple attributes.
Specified by:
modifyAttributes in interface javax.naming.directory.DirContext
Parameters:
name - The name of the object whose attributes you want to set. Do not pass null.
mod_op - A constant that identifies the modification that you want to make. Constants are defined in the DirContext interface in JNDI, and they end with "_ATTRIBUTE".
attrs - A list of attributes that you want to modify.
Throws:
BIInvalidNameException - If name is null or empty.
BINoPermissionException - If name is in the root folder.
javax.naming.NamingException - If any other naming error occurs.
See Also:
modifyAttributes(Name, int, Attributes), DirContext.ADD_ATTRIBUTE, DirContext.REMOVE_ATTRIBUTE, DirContext.REPLACE_ATTRIBUTE

modifyAttributes

public void modifyAttributes(javax.naming.Name name,
                             javax.naming.directory.ModificationItem[] mods)
                      throws javax.naming.NamingException
Modifies attributes for an object.
Specified by:
modifyAttributes in interface javax.naming.directory.DirContext
Parameters:
name - The name of the object whose attributes you want to set. Do not pass null.
mods - An array of modifications that you want to make. Each ModificationItem identifies the modification that you want and the attribute that you want to change.
Throws:
BIInvalidNameException - If name is null or empty.
BINoPermissionException - If name is in the root folder.
javax.naming.NamingException - If any other naming error occurs.
See Also:
modifyAttributes(String, ModificationItem[]), ModificationItem

modifyAttributes

public void modifyAttributes(java.lang.String name,
                             javax.naming.directory.ModificationItem[] mods)
                      throws javax.naming.NamingException
Modifies attributes for an object.
Specified by:
modifyAttributes in interface javax.naming.directory.DirContext
Parameters:
name - The name of the object whose attributes you want to set. Do not pass null.
mods - An array of modifications that you want to make. Each ModificationItem identifies the modification that you want and the attribute that you want to change.
Throws:
BIInvalidNameException - If name is null or empty.
BINoPermissionException - If name is in the root folder.
AttributeModificationException - If the modification fails.
javax.naming.NamingException - If any other naming error occurs.
See Also:
modifyAttributes(Name, ModificationItem[]), ModificationItem

bind

public void bind(javax.naming.Name name,
                 java.lang.Object object,
                 javax.naming.directory.Attributes attrs)
          throws javax.naming.NamingException
Saves a Persistable object to the repository. This method binds name to object, so that object can be found later.
Specified by:
bind in interface javax.naming.directory.DirContext
Parameters:
name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.
object - The object to save. The object must be of type Persistable.
attrs - Attributes for object.
Throws:
BIInvalidNameException - If name is null or empty.
BINameAlreadyBoundException - If another object is already bound to name. Call rebind to replace a binding.
BIInvalidAttributesException - If any of the attributes in attrs is invalid.
BINoPermissionException - If the caller does not have permission to save objects to this context.
BINamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface. Also throws BINamingException if you try to use this method to create a folder. Call createSubcontext instead.
See Also:
bind(String, Object, Attributes), createSubcontext(javax.naming.Name), rebind(javax.naming.Name, java.lang.Object), PSRConstants, Persistable, PersistableConstants

bind

public void bind(java.lang.String name,
                 java.lang.Object object,
                 javax.naming.directory.Attributes attrs)
          throws javax.naming.NamingException
Saves a Persistable object to the repository. This method binds name to object, so that object can be found later.
Specified by:
bind in interface javax.naming.directory.DirContext
Parameters:
name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.
object - The object to save. The object must be of type Persistable.
attrs - Attributes for object.
Throws:
BIInvalidNameException - If name is null or empty.
BINameAlreadyBoundException - If another object is already bound to name. Call rebind to replace a binding.
BIInvalidAttributesException - If any of the attributes in attrs is invalid.
BINoPermissionException - If the caller does not have permission to save objects to this context.
BINamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface. Also throws BINamingException if you try to use this method to create a folder. Call createSubcontext instead.
See Also:
bind(String, Object, Attributes), createSubcontext(javax.naming.Name), rebind(javax.naming.Name, java.lang.Object), PSRConstants, Persistable, PersistableConstants

rebind

public void rebind(javax.naming.Name name,
                   java.lang.Object object,
                   javax.naming.directory.Attributes attrs)
            throws javax.naming.NamingException
Saves a Persistable object to a name that is already in the repository. This method binds an object to a name that is already bound, replacing the existing binding. If the name is not already bound, then this method binds the object to the name, just as the bind method does.
Specified by:
rebind in interface javax.naming.directory.DirContext
Parameters:
name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.
object - The object to save. The object must be of type Persistable.
attrs - Attributes for object.
Throws:
BIInvalidNameException - If name is null or empty.
BINamingException - If object is a PersistenceManagerImpl. Call createSubcontext to create a folder.
BINoPermissionException - If the caller does not have permission to save objects to this context.
javax.naming.NamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface.
See Also:
rebind(String, Object, Attributes), PSRConstants, PersistableConstants

rebind

public void rebind(java.lang.String name,
                   java.lang.Object object,
                   javax.naming.directory.Attributes attrs)
            throws javax.naming.NamingException
Saves a Persistable object to a name that is already in the repository. This method binds an object to a name that is already bound, replacing the existing binding. If the name is not already bound, then this method binds the object to the name, just as the bind method does.
Specified by:
rebind in interface javax.naming.directory.DirContext
Parameters:
name - The path name of the object that this method saves. Do not pass null or an empty Name. The path that you specify must exist. This method does not create intermediate subcontexts.
object - The object to save. The object must be of type Persistable.
attrs - Attributes for object.
Throws:
BIInvalidNameException - If name is null or empty.
BINamingException - If object is a PersistenceManagerImpl. Call createSubcontext to create a folder.
BINoPermissionException - If the caller does not have permission to save objects to this context.
javax.naming.NamingException - If another naming error occurs, such as when object is null or when object does not implement the Persistable interface.
See Also:
rebind(Name, Object, Attributes), PSRConstants, PersistableConstants

createSubcontext

public javax.naming.directory.DirContext createSubcontext(javax.naming.Name name,
                                                          javax.naming.directory.Attributes attrs)
                                                   throws javax.naming.NamingException
Creates a PersistenceManager that represents a folder.
Specified by:
createSubcontext in interface javax.naming.directory.DirContext
Parameters:
name - The name for the folder to create. Do not pass null or an empty Name.
attrs - - The attributes for the folder. Valid attributes are defined in oracle.dss.persistence.PSRConstants and in oracle.dss.util.persistence.PersistableConstants.
Returns:
The PersistenceManager for the new folder.
Throws:
BIInvalidNameException - If name is null or empty.
BINameAlreadyBoundException - If another object is already bound to name.
BINoPermissionException - If the caller does not have permission to create folders in this context.
javax.naming.NamingException - If another naming error occurs.
See Also:
createSubcontext(String, Attributes)

createSubcontext

public javax.naming.directory.DirContext createSubcontext(java.lang.String name,
                                                          javax.naming.directory.Attributes attrs)
                                                   throws javax.naming.NamingException
Creates a PersistenceManager that represents a folder.
Specified by:
createSubcontext in interface javax.naming.directory.DirContext
Parameters:
name - The name for the folder to create. Do not pass null or an empty Name.
attrs - - The attributes for the folder. Valid attributes are defined in oracle.dss.persistence.PSRConstants and in oracle.dss.util.persistence.PersistableConstants.
Returns:
The PersistenceManager for the new folder.
Throws:
BIInvalidNameException - If name is null or empty.
BINameAlreadyBoundException - If another object is already bound to name.
BINoPermissionException - If the caller does not have permission to create folders in this context.
javax.naming.NamingException - If another naming error occurs.
See Also:
createSubcontext(Name, Attributes)

search

public javax.naming.NamingEnumeration search(javax.naming.Name name,
                                             javax.naming.directory.Attributes matchingAttributes,
                                             java.lang.String[] attributesToReturn)
                                      throws javax.naming.NamingException
Searches a folder for objects that have specified attributes. This method retrieves specified attributes of the found objects.
Specified by:
search in interface javax.naming.directory.DirContext
Parameters:
name - The name of the folder to search.
matchingAttributes - The attributes of the objects that you want to find.
attributesToReturn - The attributes that you want this search to retrieve for objects that have matchingAttributes.
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:
BINameNotFoundException - If name cannot be found.
BINoPermissionException - If the caller does not have appropriate permission to search in name.
BINamingException - If another naming error occurs.
See Also:
DirContext.search(Name, Attributes, String[])

search

public javax.naming.NamingEnumeration search(java.lang.String name,
                                             javax.naming.directory.Attributes matchingAttributes,
                                             java.lang.String[] attributesToReturn)
                                      throws javax.naming.NamingException
Searches a folder for objects that have specified attributes. This method retrieves specified attributes of the found objects.
Specified by:
search in interface javax.naming.directory.DirContext
Parameters:
name - The name of the folder to search.
matchingAttributes - The attributes of the objects that you want to find.
attributesToReturn - The attributes that you want this search to retrieve for objects that have matchingAttributes.
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:
BINameNotFoundException - If name cannot be found.
BINoPermissionException - If the caller does not have appropriate permission to search in name.
BINamingException - If another naming error occurs.
See Also:
DirContext.search(String, Attributes, String[])

search

public javax.naming.NamingEnumeration search(javax.naming.Name name,
                                             javax.naming.directory.Attributes matchingAttributes)
                                      throws javax.naming.NamingException
Searches a folder for objects that have specified attributes. This method retrieves the found objects.
Specified by:
search in interface javax.naming.directory.DirContext
Parameters:
name - The name of the folder to search.
matchingAttributes - The attributes of the objects that you want to find.
Returns:
An enumeration of SearchResult objects. The objects match the search criteria.
Throws:
BINameNotFoundException - If name cannot be found.
BINoPermissionException - If the caller does not have appropriate permission to search in name.
BINamingException - If another naming error occurs.
See Also:
DirContext.search(Name, Attributes)

search

public javax.naming.NamingEnumeration search(java.lang.String name,
                                             javax.naming.directory.Attributes matchingAttributes)
                                      throws javax.naming.NamingException
Searches a folder for objects that have specified attributes. This method retrieves the found objects.
Specified by:
search in interface javax.naming.directory.DirContext
Parameters:
name - The name of the folder to search.
matchingAttributes - The attributes of the objects that you want to find.
Returns:
An enumeration of SearchResult objects. The objects match the search criteria.
Throws:
BINameNotFoundException - If name cannot be found.
BINoPermissionException - If the caller does not have appropriate permission to search in name.
BINamingException - If another naming error occurs.
See Also:
DirContext.search(String, Attributes)

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, using the specified search scope. This method retrieves specified attributes of the found objects.
Specified by:
search in interface BIContext
Parameters:
name - The name of the folder to search.
matchingAttributes - The attributes of the objects that you want to find.
searchControls - The search controls that specify the scope of the search. This argument 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:
BINameNotFoundException - If name cannot be found.
BIInvalidSearchControlsException - If SearchControls is not valid
BINoPermissionException - If the caller does not have appropriate permission to search in name.
BINamingException - If another naming error occurs.
See Also:
BISearchControls, 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 searchControls)
                                      throws javax.naming.NamingException
Searches a folder for objects that have specified attributes, using the specified search scope. This method retrieves specified attributes of the found objects.
Specified by:
search in interface BIContext
Parameters:
name - The name of the folder to search.
matchingAttributes - The attributes of the objects that you want to find.
searchControls - The search controls that specify the scope of the search. This argument 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:
BINameNotFoundException - If name cannot be found.
BIInvalidSearchControlsException - If SearchControls is not valid.
BINoPermissionException - If the caller does not have appropriate permission to search in name.
BINamingException - If another naming error occurs.
See Also:
BISearchControls, javax.naming.directory.DirContext#search(String, Attributes, SearchControls)

getSchema

public javax.naming.directory.DirContext getSchema(javax.naming.Name name)
                                            throws javax.naming.NamingException
Retrieves the schema of an object. This method is not supported.
Specified by:
getSchema in interface javax.naming.directory.DirContext
Throws:
OperationNotSupportedException - Because this implementation does not support this method.

getSchema

public javax.naming.directory.DirContext getSchema(java.lang.String name)
                                            throws javax.naming.NamingException
Retrieves the schema of an object. This method is not supported.
Specified by:
getSchema in interface javax.naming.directory.DirContext
Throws:
OperationNotSupportedException - Because this implementation does not support this method.

getSchemaClassDefinition

public javax.naming.directory.DirContext getSchemaClassDefinition(javax.naming.Name name)
                                                           throws javax.naming.NamingException
Retrieves the schema definition of an object. This method is not supported.
Specified by:
getSchemaClassDefinition in interface javax.naming.directory.DirContext
Throws:
OperationNotSupportedException - Because this implementation does not support this method.

getSchemaClassDefinition

public javax.naming.directory.DirContext getSchemaClassDefinition(java.lang.String name)
                                                           throws javax.naming.NamingException
Retrieves the schema definition of an object. This method is not supported.
Specified by:
getSchemaClassDefinition in interface javax.naming.directory.DirContext
Throws:
OperationNotSupportedException - Because this implementation does not support this method.

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 object or a folder to another folder.
Specified by:
copy in interface BIContext
Parameters:
name - The name of the object or folder to copy. Must not be empty or null.
context - The folder into which to copy name. The folder must already exists.
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 - Specify the copy option. Possible values are listed in the See Also section.
Throws:
BIInvalidNameException - If name is null or empty.
BINamingException - if any other naming error occurs.
See Also:
copy(String, DirContext, String, int), 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 object or a folder to another folder.
Specified by:
copy in interface BIContext
Parameters:
name - The name of the object or folder to copy. Must not be empty or null.
context - The folder into which to copy name. The folder must already exists.
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 - Specify the copy option. Possible values are listed in the See Also section.
Throws:
BIInvalidNameException - If name is null or empty.
BINamingException - if any other naming error occurs.
See Also:
copy(Name, DirContext, Name, int), PSRConstants.NORMAL_COPY, PSRConstants.DEEP_COPY

move

public void move(javax.naming.Name name,
                 javax.naming.directory.DirContext context)
          throws javax.naming.NamingException
Moves an object or a folder to another folder.
Specified by:
move in interface BIContext
Parameters:
name - The name of the object or folder to move. Do not pass null or an empty String.
context - The folder into which to move name. The folder must already exist.
Throws:
BIInvalidNameException - If name is null or empty.
BINamingException - If any other naming error occurs.
See Also:
move(String, DirContext)

move

public void move(java.lang.String name,
                 javax.naming.directory.DirContext context)
          throws javax.naming.NamingException
Moves an object or a folder to another folder.
Specified by:
move in interface BIContext
Parameters:
name - The name of the object or folder to move. Do not pass null or an empty String.
context - The folder into which to move name. The folder must already exist.
Throws:
BIInvalidNameException - If name is null or empty.
BINamingException - if any other naming error occurs.
See Also:
move(Name, DirContext)

getAcl

public Acl getAcl()
           throws javax.naming.NamingException
Retrieves the access control list of this folder. This method returns an implementation of a AclObject, which extends Acl. To access the methods in AclObject, downcast the object that this method returns.
Specified by:
getAcl in interface BIContext
Returns:
The access control list.
Throws:
javax.naming.NamingException - if a problem occurs.
See Also:
AclObject

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.
Specified by:
lookup in interface BIContext
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:
lookup(Name, Persistable), Persistable

lookup

public java.lang.Object lookup(javax.naming.Name name,
Persistable persistable)
                        throws javax.naming.NamingException
Updates a Persistable object or folder from the repository. Use this method to reuse an already-loaded Persistable. This method applies the XML from the repository to a Persistable that is already loaded in memory.
Specified by:
lookup in interface BIContext
Parameters:
name - The name of the object to be load. Do not pass null.
persistable - The Persistable object to reuse.
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:
lookup(String, Persistable), Persistable

lookup

public java.lang.Object lookup(java.lang.String name,
Persistable persistable,
                               java.util.Hashtable args)
                        throws javax.naming.NamingException
Updates a Persistable object or folder from the repository. Use this method to reuse an already-loaded Persistable. This method applies the XML from the repository to a Persistable that is already loaded in memory.
Specified by:
lookup in interface BIContext
Parameters:
name - The name of the object to be load. Do not pass null.
persistable - The Persistable object to reuse.
args - Arguments for initializing the Persistable object as it is loaded. For more detail, please see the initialize method on the Persistable interface.
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:
lookup(Name, Persistable, Hashtable), Persistable.initialize(java.util.Hashtable)

lookup

public java.lang.Object lookup(javax.naming.Name name,
Persistable persistable,
                               java.util.Hashtable args)
                        throws javax.naming.NamingException
Updates a Persistable object or folder from the repository. Use this method to reuse an already-loaded Persistable. This method applies the XML from the repository to a Persistable that is already loaded in memory.
Specified by:
lookup in interface BIContext
Parameters:
name - The name of the object to be load. Do not pass null.
persistable - The Persistable object to reuse.
args - Arguments for initializing the Persistable object as it is loaded. For more detail, please see the initialize method on the Persistable interface.
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:
lookup(String, Persistable, Hashtable), Persistable.initialize(java.util.Hashtable)

lookupDefinition

public java.lang.Object lookupDefinition(javax.naming.Name name)
                                  throws javax.naming.NamingException
Retrieves the StateAgent of an object, without actually instantiating the object itself. The StateAgent contains the persisted state of the object.
Specified by:
lookupDefinition in interface PersistenceManager
Parameters:
name - The name of the object whose StateAgent you want.
Returns:
The StateAgent of the object.
Throws:
BIInvalidNameException - If name is null or empty.
BINoPermissionException - If the caller does not have appropriate permission to search in name.
BINamingException - If another naming error occurs.
BINameNotFoundException - If the object or folder cannot be found.
See Also:
lookupDefinition(String), StateAgent

lookupDefinition

public java.lang.Object lookupDefinition(java.lang.String name)
                                  throws javax.naming.NamingException
Retrieves the StateAgent of an object, without actually instantiating the object itself. The StateAgent contains the persisted state of the object.
Specified by:
lookupDefinition in interface PersistenceManager
Parameters:
name - The name of the object whose StateAgent you want.
Returns:
The StateAgent of the object.
Throws:
BIInvalidNameException - If name is null or empty.
BINoPermissionException - If the caller does not have appropriate permission to search in name.
BINamingException - If another naming error occurs.
BINameNotFoundException - If the object or folder cannot be found.
See Also:
lookupDefinition(Name), StateAgent

exportSubcontext

public boolean exportSubcontext(javax.naming.directory.Attributes filterAttrs,
                                java.lang.String exportFileName)
Exports the current folder to an external source. This method exports the current folder to a file. The export includes the StateAgent of each object in the folder, as well as subfolders and their contents. You can limit the export of the contents of this folder by specifying the attributes of the objects that should be exported, in filterAttrs.
Specified by:
exportSubcontext in interface PersistenceManager
Parameters:
filterAttrs - Attributes of objects that you want to export.
exportFileName - The name for the exported file.
Returns:
true if the operation is successful, false if it is not.

importSubcontext

public boolean importSubcontext(java.lang.String importFileName)
Imports a folder from an external source. This method imports a folder and its contents from a file. The file should be an XML file that defines the state of the folder and its contents.
Specified by:
importSubcontext in interface PersistenceManager
Parameters:
importFileName - The name of the file that contains the persisted state of the folder that you want to import.
Returns:
true if the operation is successful, false if it is not.

getLocale

public java.util.Locale getLocale()
Retrieves the locale for the persistence service.
Specified by:
getLocale in interface BIContext
Returns:
The locale setting for the persistence service, or the the system default locale, if no locale has been explicitly set for the persistence service.

setLocale

public void setLocale(java.util.Locale locale)
Specifies the locale that the persistence service uses. Setting the locale updates all PersistenceManager instances with the new locale setting.
Specified by:
setLocale in interface BIContext
Parameters:
locale - The locale to set on the entire persistence service.

associate

public void associate(java.lang.String relativeSourceName,
                      java.lang.String[] fullNameOfTarget,
                      javax.naming.directory.Attribute[] identifier)
               throws javax.naming.NamingException
Associates an object with a set of objects.
Specified by:
associate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
fullNameOfTarget - An array of the names of the target objects to associate with. Each name should not be null or an empty String.
identifiers - An array of attributes which identifies the associations.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName or any of the target objects cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

associate

public void associate(javax.naming.Name relativeSourceName,
                      javax.naming.Name fullNameOfTarget,
                      javax.naming.directory.Attribute identifier)
               throws javax.naming.NamingException
Associates an object with another object.
Specified by:
associate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
fullNameOfTarget - The name of the target object to associate with. Do not pass null or an empty Name.
identifiers - An attribute which identifies the association.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName or any of the target objects cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

associate

public void associate(java.lang.String relativeSourceName,
                      java.lang.String fullNameOfTarget,
                      javax.naming.directory.Attribute identifier)
               throws javax.naming.NamingException
Associates an object with another object.
Specified by:
associate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
fullNameOfTarget - The name of the target object to associate with. Do not pass null or an empty String.
identifiers - An attribute which identifies the association.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName or any of the target objects cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

associate

public void associate(javax.naming.Name relativeSourceName,
                      javax.naming.Name[] fullNameOfTarget,
                      javax.naming.directory.Attribute[] identifiers)
               throws javax.naming.NamingException
Associates an object with a set of objects.
Specified by:
associate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
fullNameOfTarget - An array of the names of the target objects to associate with. Each name should not be null or an empty Name.
identifiers - An array of attributes which identifies the associations.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName or any of the target objects cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

dissociate

public void dissociate(java.lang.String relativeSourceName,
                       javax.naming.directory.Attribute identifier)
                throws javax.naming.NamingException
Dissociates an object from other objects.
Specified by:
dissociate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
identifier - An attribute which identifies the association.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

dissociate

public void dissociate(javax.naming.Name relativeSourceName,
                       javax.naming.directory.Attribute identifier)
                throws javax.naming.NamingException
Dissociates an object from other objects.
Specified by:
dissociate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
identifier - An attribute which identifies the association.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

dissociate

public void dissociate(java.lang.String relativeSourceName,
                       javax.naming.directory.Attribute[] identifiers)
                throws javax.naming.NamingException
Dissociates an object from other objects.
Specified by:
dissociate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
identifiers - An array of attributes which identifies the associations.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

dissociate

public void dissociate(javax.naming.Name relativeSourceName,
                       javax.naming.directory.Attribute[] identifiers)
                throws javax.naming.NamingException
Dissociates an object from other objects.
Specified by:
dissociate in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
identifiers - An array of attributes which identifies the associations.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

listAssociates

public java.util.Vector listAssociates(java.lang.String relativeSourceName,
                                       java.lang.String[] attrsToReturn,
                                       javax.naming.directory.Attribute identifier)
                                throws javax.naming.NamingException
Returns a list of associate objects specified by the identifier.
Specified by:
listAssociates in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
attrsToReturn - A list of attributes to return.
identifier - The identifier of the association.
Returns:
A Vector of BIAssociate objects, one for each object in the folder. Each BIAssociate contains the name of an object, its class name, and the object itself.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

listAssociates

public java.util.Vector listAssociates(javax.naming.Name relativeSourceName,
                                       java.lang.String[] attrsToReturn,
                                       javax.naming.directory.Attribute identifier)
                                throws javax.naming.NamingException
Returns a list of associate objects specified by the identifier.
Specified by:
listAssociates in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
attrsToReturn - A list of attributes to return.
identifier - The identifier of the association.
Returns:
A Vector of BIAssociate objects, one for each object in the folder. Each BIAssociate contains the name of an object, its class name, and the object itself.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

listReferringAssociates

public java.util.Vector listReferringAssociates(java.lang.String relativeSourceName,
                                                java.lang.String[] attrsToReturn,
                                                javax.naming.directory.Attribute identifier)
                                         throws javax.naming.NamingException
Returns a list of associate objects referred to or referred by the source object.
Specified by:
listReferringAssociates in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
attrsToReturn - A list of attributes to return.
identifier - The identifier of the association.
Returns:
A Vector of BIAssociate objects, one for each object in the folder. Each BIAssociate contains the name of an object, its class name, and the object itself.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

listReferringAssociates

public java.util.Vector listReferringAssociates(javax.naming.Name relativeSourceName,
                                                java.lang.String[] attrsToReturn,
                                                javax.naming.directory.Attribute identifier)
                                         throws javax.naming.NamingException
Returns a list of associate objects referred to or referred by the source object.
Specified by:
listReferringAssociates in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
attrsToReturn - A list of attributes to return.
identifier - The identifier of the association.
Returns:
A Vector of BIAssociate objects, one for each object in the folder. Each BIAssociate contains the name of an object, its class name, and the object itself.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

getAssociateObject

public java.lang.Object getAssociateObject(java.lang.String relativeSourceName,
                                           javax.naming.directory.Attribute identifier)
                                    throws javax.naming.NamingException
Retrieve the associated object specified by the identifier.
Specified by:
getAssociateObject in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty String.
identifier - The attribute that identifies the association.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

getAssociateObject

public java.lang.Object getAssociateObject(javax.naming.Name relativeSourceName,
                                           javax.naming.directory.Attribute identifier)
                                    throws javax.naming.NamingException
Retrieve the associated object specified by the identifier.
Specified by:
getAssociateObject in interface PersistenceManager
Parameters:
relativeSourceName - The name of the source object. Do not pass null or an empty Name.
identifier - The attribute that identifies the association.
Throws:
BIInvalidNameException - If relativeSourceName is null or empty.
BINameNotFoundException - If relativeSourceName cannot be found.
BIInvalidAttributesException - If the mandatory attributes, such as the OBJECT_TYPE attribute, are not provided.
BINoPermissionException - If the user does not have sufficient permission to perform this operation.
BINamingException - If another naming error occurs.

exportSubcontext

public boolean exportSubcontext(java.lang.String fileName,
TransferControl control)
                         throws javax.naming.NamingException
Exports contents of the current folder to a file. You can limit the export of the contents of this folder by specifying the TransferControl.
Specified by:
exportSubcontext in interface PersistenceManager
Parameters:
fileName - The local file in which the contents are exported to.
control - The TransferControl that provides fine grain control of the export function.
Returns:
true if the operation is successful, false if it is not.
Throws:
BINamingException - if an error has occurred.

importSubcontext

public boolean importSubcontext(java.lang.String fileName,
TransferControl control)
                         throws javax.naming.NamingException
Imports the content of a folder from a file. The file should be an XML file that defines the state of the folder and its contents.
Specified by:
importSubcontext in interface PersistenceManager
Parameters:
fileName - The name of the local file that contains the contents to import.
control - The TransferControl that provides fine grain control of the import function.
Returns:
true if the operation is successful, false if it is not.
Throws:
BINamingException - if an error has occurred.
Overview  Package   Class  Tree  Deprecated  Index  Help 

Oracle™ Business Intelligence Beans Java API Reference
Release 10g (9.0.4)
Part number B12159_01

 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES
SUMMARY:  INNER | FIELD | CONSTR | METHOD DETAIL:  FIELD | CONSTR | METHOD
Copyright © 2003, Oracle. All Rights Reserved.