com.ibm.portal.services.contentmapping
Interface ContentMappingInfoHome

public interface ContentMappingInfoHome

This interface is the home of all APIs providing access to content mapping information. Content mapping information in this context refers to portal resources being mapped to instances of a content store where resources can be identified via unique IDs (e.g. JCR GUIDs) and/or content paths. Home interface lookup:

 
      Context ctx = new InitialContext();
      ContentMappingInfoHome myHome = (ContentMappingInfoHome) ctx.lookup(ContentMappingInfoHome.JNDI_NAME);
 

Since:

7.0.0.0

See Also:

ContentMapping, ContentMappingInfo

Field Summary

static java.lang.String

JNDI_NAME The JNDI name used to bind the ContentMappingInfoHome singleton.

Method Summary

ContentMappingDelegationService	getContentMappingDelegationService(ContentMappingInfo contentMappingInfo) Returns the ContentMappingDelegationService for the given ContentMappingInfo object.
ContentMappingInfo	getContentMappingInfo(Identifiable resource) Returns the ContentMappingInfo object for the given portal resource giving access to all content mappings assigened to that resource.
java.util.List<? extends ContentMappingInfo>	getContentMappingInfo(java.util.List<ObjectID> resources) Returns the list of ContentMappingInfo objects for the given list of portal resource IDs.
ContentMappingInfoController	getContentMappingInfoController() Returns a ContentMappingInfoController object that can be used to create modifiable versions of ContentMappingInfo objects and to commit modifications done to corresponding ModifiableContentMappingInfo objects.
ContentMappingLocator	getContentMappingLocator() Returns the ContentMappingLocator that can be used to search for specific content mappings in the default scope.
ContentMappingLocator	getContentMappingLocator(java.lang.String scopeProviderName) Returns the ContentMappingLocator that can be used to search for specific content mappings in the set of scopes handled by a specific scope provider.
GlobalContentMappingDelegationService	getGlobalContentMappingDelegationService() Returns the global ContentMappingDelegationService for the default scope.
GlobalContentMappingDelegationService	getGlobalContentMappingDelegationService(java.lang.String scopeProviderName) Returns the global ContentMappingDelegationService for the scopes handled by a specific scope provider.
ContentMappingInfoController	getPropagatingContentMappingInfoController(ContentModel<ContentNode> model, java.lang.String[] scopes, int numberThreshold, int nestingDepth) Returns a ContentMappingInfoController object that can be used to create modifiable versions of ContentMappingInfo objects and to commit modifications done to corresponding ModifiableContentMappingInfo objects.
ResourceLocator	getResourceLocator() Returns the ResourceLocator interface that can be used to search for specific portal resources based on content mapping information in the default scope.
ResourceLocator	getResourceLocator(java.lang.String scopeProviderName) Returns the ResourceLocator interface that can be used to search for specific portal resources based on content mapping information in the set of scopes handled by a specific scope provider.
ScopeProvider	getScopeProvider(java.lang.String scopeProviderName) Returns the scope provider for a given scope provider name.
IterableListModel<ScopeProvider>	getScopeProviders() Returns the list of available content mapping scope providers.

Field Detail

JNDI_NAME

static final java.lang.String JNDI_NAME

The JNDI name used to bind the ContentMappingInfoHome singleton.

See Also:

Constant Field Values

Method Detail

getContentMappingInfo

ContentMappingInfo getContentMappingInfo(Identifiable resource)
                                         throws ContentMappingDataBackendException

Returns the ContentMappingInfo object for the given portal resource giving access to all content mappings assigened to that resource. The returned ContentMappingInfo is a one time copy read from the database. The object may become stale if cached. This method never returns null.

Parameters:

resource - Identifies the portal resource

Throws:

ContentMappingDataBackendException

getContentMappingInfo

java.util.List<? extends ContentMappingInfo> getContentMappingInfo(java.util.List<ObjectID> resources)
                                                                   throws ContentMappingDataBackendException

Returns the list of ContentMappingInfo objects for the given list of portal resource IDs. The sequence of objects in the result matches the sequence of ObjectID objects passed in via the resources parameter.
Important:All resource IDs passed in need to be of the same ObjectType.

Parameters:

resources - Identifies the portal resources and the defines the result sequence ordering.

Throws:

ContentMappingDataBackendException

See Also:

ObjectType

getResourceLocator

ResourceLocator getResourceLocator()

Returns the ResourceLocator interface that can be used to search for specific portal resources based on content mapping information in the default scope. The locator returned by this method is thread safe and can be cached.

getResourceLocator

ResourceLocator getResourceLocator(java.lang.String scopeProviderName)

Returns the ResourceLocator interface that can be used to search for specific portal resources based on content mapping information in the set of scopes handled by a specific scope provider. The locator returned by this method is thread safe and can be cached.

Parameters:

scopeProviderName - The name of relevant scopeProvider

See Also:

ScopeProvider

getContentMappingLocator

ContentMappingLocator getContentMappingLocator()

Returns the ContentMappingLocator that can be used to search for specific content mappings in the default scope. The locator returned by this method is thread safe and can be cached.

getContentMappingLocator

ContentMappingLocator getContentMappingLocator(java.lang.String scopeProviderName)

Returns the ContentMappingLocator that can be used to search for specific content mappings in the set of scopes handled by a specific scope provider. The locator returned by this method is thread safe and can be cached.

Parameters:

scopeProviderName - The name of relevant scopeProvider

See Also:

ScopeProvider

getContentMappingDelegationService

ContentMappingDelegationService getContentMappingDelegationService(ContentMappingInfo contentMappingInfo)

Returns the ContentMappingDelegationService for the given ContentMappingInfo object.

getGlobalContentMappingDelegationService

GlobalContentMappingDelegationService getGlobalContentMappingDelegationService()

Returns the global ContentMappingDelegationService for the default scope. This service instance does not have a dedicated connection to a portal resource. The services returned by this method is thread safe and can be cached.

getGlobalContentMappingDelegationService

GlobalContentMappingDelegationService getGlobalContentMappingDelegationService(java.lang.String scopeProviderName)

Returns the global ContentMappingDelegationService for the scopes handled by a specific scope provider. This service instance does not have a dedicated connection to a portal resource. The services returned by this method is thread safe and can be cached.

Parameters:

scopeProviderName - The name of relevant scopeProvider

See Also:

ScopeProvider

getContentMappingInfoController

ContentMappingInfoController getContentMappingInfoController()

Returns a ContentMappingInfoController object that can be used to create modifiable versions of ContentMappingInfo objects and to commit modifications done to corresponding ModifiableContentMappingInfo objects.

See Also:

ModifiableContentMappingInfo

getPropagatingContentMappingInfoController

ContentMappingInfoController getPropagatingContentMappingInfoController(ContentModel<ContentNode> model,
                                                                        java.lang.String[] scopes,
                                                                        int numberThreshold,
                                                                        int nestingDepth)

Returns a ContentMappingInfoController object that can be used to create modifiable versions of ContentMappingInfo objects and to commit modifications done to corresponding ModifiableContentMappingInfo objects. Modifications are propagated down to descendant resources during commit.

Parameters:

model - The content model providing the resource hierarchy used for propagation.

scopes - Lists all scopes for which propagation shall be enabled (must not be null).

numberThreshold - The maximum numbers of child pages to be updated during propagation.

nestingDepth - The maximum number of nesting levels to consider during propagation. Deeper nested resources are ignored. Setting the levels parameter to 1 means, that updates are only propagated to the direct child resources.

See Also:

ModifiableContentMappingInfo

getScopeProviders

IterableListModel<ScopeProvider> getScopeProviders()

Returns the list of available content mapping scope providers.

Returns:

getScopeProvider

ScopeProvider getScopeProvider(java.lang.String scopeProviderName)

Returns the scope provider for a given scope provider name.

Returns:

The scope provider with the given name. If no matching scope providers is available, null is returned.