oracle.dss.persistence.persistencemanager.common
Interface PersistenceManager

All Superinterfaces:

BIContext, javax.naming.Context, javax.naming.directory.DirContext, ErrorHandlerCallback

All Known Implementing Classes:

InitialPersistenceManager, PersistenceManagerImpl

public interface PersistenceManager

extends BIContext, ErrorHandlerCallback

The directory service interface for the BI Beans. This interface specifies methods for moving, copying, and linking to objects and contexts. It also includes a method for retrieving access control information.

As an extension of the javax.naming.DirContext interface, this interface represents a directory context. A directory context is a directory-like object in a storage system. The default storage system for a PersistenceManager is an Oracle9i database.

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

See Also:

PSRConstants, PersistableConstants

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	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[] identifiers) 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	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 context to an XML file.
boolean	exportSubcontext(java.lang.String fileName, TransferControl control) Exports contents of the current folder to a file.
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.
boolean	importSubcontext(java.lang.String importFileName) Imports a context from an XML file.
boolean	importSubcontext(java.lang.String fileName, TransferControl control) Imports the content of a folder from a file.
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.
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	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.

Methods inherited from interface oracle.dss.bicontext.BIContext

copy, copy, getAcl, getLocale, lookup, lookup, lookup, lookup, move, move, refresh, search, search, setLocale

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

Methods inherited from interface oracle.dss.util.ErrorHandlerCallback

addErrorHandler, removeErrorHandler

Method Detail

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, in XML.

Parameters:

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

Returns:

The StateAgent that defines the state of of the object.

Throws:

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

See Also:

StateAgent

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, in XML.

Parameters:

name - The name of the object to retrieve. The name should include path names.

Returns:

The StateAgent that defines the state of the object.

Throws:

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

See Also:

StateAgent

exportSubcontext

public boolean exportSubcontext(javax.naming.directory.Attributes filterAttrs,
                                java.lang.String exportFileName)

Exports the current context to an XML file. You use filterAttrs to filter the objects in this context to export. For example, you could export only the Graph objects in this context.

Parameters:

filterAttrs - Attributes that identify the contents of this context to export.

exportFileName - The desired location and name of the XML file.

Returns:

true if the XML file is created, false if it is not.

importSubcontext

public boolean importSubcontext(java.lang.String importFileName)

Imports a context from an XML file.

Parameters:

importFileName - The name of the file that contains the XML for the context to import. A forward slash (/) separates folder names. The path is relative to this context.

Returns:

true if the context is imported successfully, false if it is not.

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.

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 identifier)
               throws javax.naming.NamingException

Associates an object with another object.

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[] identifiers)
               throws javax.naming.NamingException

Associates an object with a set of objects.

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[] identifiers)
               throws javax.naming.NamingException

Associates an object with a set of objects.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.