com.sap.netweaver.bc.rf.mi
Interface IManager

[contained in: com.sap.netweaver.bc.rf.par - bc.rf.mi_api.jar]

All Known Implementing Classes:

AbstractManager

public interface IManager

Interface describing a repository manager. A repository manager is the main unit, needed to integrate a repository into the repository framework.

Method Summary

java.lang.String	getId() Get the unique id of the repository manager (usually assigned and made unique through the configuration framework).
NameInfo	getNameInfo() Get the NameInfo of a repository manager.
java.lang.String	getRidPrefix() Get the root token of a resource id, this resource manager claims responsibility for.
java.util.Map	getSubManagers() Get map of sub managers indexed by sub manager interface, e.g. a repository manager with a content and property sub manager implemented in one class and a separate security sub manager implemented in another class, returns a map with the content and property sub manager added twice via the content sub manager interface and the property sub manager interface and the security sub manager via the security sub manager interface.
java.util.Set	getSupportedOptions(IResourceHandle resourceHandle) Get set of options this repository manager supports.
IResourceHandle	lookup(IRid rid) Look up a resource in this repository by resource identifer.
java.util.List	lookup(java.util.List ridList, boolean contentToBeFetched, java.util.List propertyNamesToBeFetched) Look up resources in repository by list of resource ids and prefetch content and certain properties when requested. Note: This method needs not to be handled atomically!
java.util.List	lookup(java.util.List ridList, java.util.Map content, java.util.Map properties, java.lang.String[] permissionNames) Look up resources in repository by list of resource ids and check thereby for the given permission names.

Method Detail

getId

public java.lang.String getId()

Get the unique id of the repository manager (usually assigned and made unique through the configuration framework).

Returns:

unique id of the repository manager

getRidPrefix

public java.lang.String getRidPrefix()

Get the root token of a resource id, this resource manager claims responsibility for. The framework will call this method to know which repository manager to call when a resource having the matching root token needs to be handled.

Returns:

root token of a resource id, this resource manager claims responsibility for

getNameInfo

public NameInfo getNameInfo()

Get the NameInfo of a repository manager. The NameInfo contains information about the restrictions for resource and collection names.

Returns:

information about the restrictions for resource and collection names

getSubManagers

public java.util.Map getSubManagers()

Get map of sub managers indexed by sub manager interface, e.g. a repository manager with a content and property sub manager implemented in one class and a separate security sub manager implemented in another class, returns a map with the content and property sub manager added twice via the content sub manager interface and the property sub manager interface and the security sub manager via the security sub manager interface.

Returns:

map of sub managers indexed by sub manager interface

lookup

public IResourceHandle lookup(IRid rid)
                       throws ResourceException

Look up a resource in this repository by resource identifer. Must return null if the resource does not exist.

Parameters:

rid - resource identifier to be looked up.

Returns:

The resource handle or null if the resource with the specified RID does not exist. null must be returned only if the resource definitively does not exist; if the lookup fails for some other reason (e.g. internal error, invalid RID) an appropriate exception such as ServiceNotAvailableException must be thrown.

Throws:

ResourceException - if the RID is invalid or the lookup failed.

lookup

public java.util.List lookup(java.util.List ridList,
                             boolean contentToBeFetched,
                             java.util.List propertyNamesToBeFetched)
                      throws ResourceException,
                             OperationNotCompletedException

Look up resources in repository by list of resource ids and prefetch content and certain properties when requested.

Note: This method needs not to be handled atomically! Although this operation may fail in parts, the operation on one of the many operands provided through the parameter list is always expected to be atomic!

Parameters:

ridList - list of resource ids to be looked up

contentToBeFetched - flag indicating whether or not content should prefetched; content not prefetched must still be available via subsequent IContentManager calls

propertyNamesToBeFetched - list of property names to be prefetched; properties not prefetched must still be available via subsequent IPropertyManager calls

Returns:

looked up resources

Throws:

ResourceException - Exception raised in failure situation

OperationNotCompletedException - when the operation failed in parts

lookup

public java.util.List lookup(java.util.List ridList,
                             java.util.Map content,
                             java.util.Map properties,
                             java.lang.String[] permissionNames)
                      throws ResourceException,
                             OperationNotCompletedException

Look up resources in repository by list of resource ids and check thereby for the given permission names. This is a performance optimized bulk call: When no content is provided (null or empty content parameter) the real content must be looked up. Otherwise the repository should use the given content for the returned resources and don't spend time on retrieving the real content. The same goes for properties. When no permission names are provided (null or empty permission parameter), no permissions must be checked.

Note: This method needs not to be handled atomically! Although this operation may fail in parts, the operation on one of the many operands provided through the parameter list is always expected to be atomic!

Parameters:

ridList - list of resource ids to be looked up

content - map of content to be used for the returned resources, where the key is the RID and the value is the content

properties - map of properties to be used for the returned resources, where the key is the RID and the value is a list of properties

permissionNames - array of permission names to be checked for or null or empty for no check

Returns:

looked up resources

Throws:

ResourceException - Exception raised in failure situation

OperationNotCompletedException - when the operation failed in parts

getSupportedOptions

public java.util.Set getSupportedOptions(IResourceHandle resourceHandle)

Get set of options this repository manager supports. In case of a null resource handle, the repository shall return the set of all supported operations.

Parameters:

resourceHandle - resource handle

Returns:

set of options this repository manager supports