oracle.webcenter.spaces

Interface SpacesManager

public interface SpacesManager

Spaces Manager Class is a manager class responsible for managing all Space objects. It also acts as a frontend for all the external applications which try to get access to Space. All the access to the Space class should be made through getSpace() method of this class. Spaces can be created/deleted/modified using the APIs provided by this class. It also provides different sorts of querying mechanism for calling APIs to get the appropriate list of Space objects. One should always get the SpacesManager from SpacesManagerFactory.

The following code snippet depicts how one can get hold of SpacesManager:
SpacesManagerFactory fact = FactoryFinder.getFactory(SpacesManagerFactory.class.getCanonicalName());
SpacesManager manager = fact.getSpacesManager();


Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	SpacesManager.UpdateType In the refresh API we can use this to either update METADATA, security or both metadata and security

Method Summary

Modifier and Type	Method and Description
Space	createGroupSpace(SpaceTemplate baseTemplate, SpaceCreationOptions options) Create API creates a new Space object from an existing Space template.
Space	createGroupSpace(java.lang.String spaceName, Space parentSpace, SpaceTemplate baseTemplate, java.util.Map<java.lang.String,java.lang.String> customAttributes, java.lang.String description) Create API creates a new Space object from an existing Space template.
Space	createGroupSpace(java.lang.String spaceName, SpaceTemplate baseTemplate, java.util.Map<java.lang.String,java.lang.String> customAttributes, java.lang.String description) Create API creates a new Space object from an existing Space template.
Space	deleteGroupSpace(Space space) This API deletes the given Spaces metadata from MDS.
java.util.List<GSMetadata>	executeQuery(PortalInstanceQuery query, ResultsOrder order, int limit, int start) Execute Portal API query.
java.util.List<GSMetadata>	getPortals(SpacesQueryOptions sqo) Get the portals using the query options
java.util.List<java.lang.String>	getPublicSpacesNamesList(java.lang.String namePattern) Deprecated. use getSpaces(SpacesQueryParameters)
Space	getSpace(oracle.mds.core.MDSSession session, java.lang.String name) Deprecated. use getSpace(name)
Space	getSpace(java.lang.String name) This API returns Space class object for a given name of the Space.
Space	getSpaceByScopeGUID(java.lang.String GUID) This API returns the Space object given its GUID
Space	getSpaceFromDisplayName(java.lang.String displayName) This API returns the Space object given its displayName
default GSMetadata	getSpaceMetadata(java.lang.String scopeGUID) This API returns GSMetadata object for the passed in the space GUID This is the default implementation but the actual implementation is in
java.util.List<Space>	getSpaces(oracle.mds.query.Condition queryCondition, boolean subscribedOnly) Deprecated. use getSpaces(SpacesQueryParameters)
java.util.List<Space>	getSpaces(oracle.mds.core.MDSSession session, oracle.mds.query.Condition queryCondition, boolean subscribedOnly) Deprecated. use getSpaces(SpacesQueryParameters)
java.util.List<GSMetadata>	getSpaces(SpacesQueryOptions sqo) Deprecated. use getSpaces(SpacesQueryParameters)
java.util.List<GSMetadata>	getSpaces(SpacesQueryParameters sq) Evaluates a spaces query and returns a list of space metadata objects based on the result.
java.util.List<Space>	getSpacesList(java.lang.String namePattern) Deprecated. use getSpaces(SpacesQueryParameters)
java.util.List<java.lang.String>	getUserSpacesNamesList(java.lang.String namePattern) Deprecated. use getSpaces(SpacesQueryParameters)
Future	refreshGroupSpaceCache(java.util.List<java.lang.String> spaceNames, SpacesManager.UpdateType updateType, boolean syncMode, boolean cleanGSTableCache) Deprecated.
void	renameGroupSpace(java.lang.String oldSpaceName, java.lang.String newSpaceName) This API changes the name of the existing space to a new name

Method Detail

getSpace

Space getSpace(java.lang.String name)
        throws SpacesException

This API returns Space class object for a given name of the Space. It also validates whether the Space of given name exists in the metadata or not. It throws the Exception otherwise.

Parameters:

session - MDSSession

name - : name of the Space

Returns:

Returns the space object

Throws:

SpacesException - Throws SpacesException if @[link Space} with given name is not found

getSpaceMetadata

default GSMetadata getSpaceMetadata(java.lang.String scopeGUID)
                             throws SpacesException

This API returns GSMetadata object for the passed in the space GUID This is the default implementation but the actual implementation is in

SpacesManagerImpl.java

. Here we query against the database for the given space GUID and will be creating the GSMetadata object out of the

PortalInstance

Parameters:

scopeGUID - Name of the space for which we want to get the GSMetadata

Returns:

Returns GSMetadata object for the given scope GUID

Throws:

SpacesException

getSpace

Space getSpace(oracle.mds.core.MDSSession session,
               java.lang.String name)
        throws SpacesException

Deprecated. use getSpace(name)

This API returns Space class object for a given name of the Space. It also validates whether the Space of given name exists in the metadata or not. It throws the Exception otherwise.

Parameters:

session - MDSSession

name - : name of the Space

Returns:

Returns the space object

Throws:

SpacesException - Throws SpacesException if @[link Space} with given name is not found

createGroupSpace

Space createGroupSpace(java.lang.String spaceName,
                       SpaceTemplate baseTemplate,
                       java.util.Map<java.lang.String,java.lang.String> customAttributes,
                       java.lang.String description)
                throws SpacesException

Create API creates a new Space object from an existing Space template. It calls the template's clone method to get the clone of the template and then constructs the Space Object out of it. It automatcally creates the MDS location for given Space name.

Parameters:

spaceName - The Name of the new Group Space

baseTemplate - Template on which the space should be based upon

customAttributes - Attribute map for custom attributes (name,value) pairs

Returns:

Space class for a newly created Space

Throws:

SpacesException - Throws Exception if the API can not create a new Space based on given Space Template, or SpaceTemplate is not found

createGroupSpace

Space createGroupSpace(java.lang.String spaceName,
                       Space parentSpace,
                       SpaceTemplate baseTemplate,
                       java.util.Map<java.lang.String,java.lang.String> customAttributes,
                       java.lang.String description)
                throws SpacesException

Create API creates a new Space object from an existing Space template. It calls the template's clone method to get the clone of the template and then constructs the Space Object out of it. It automatcally creates the MDS location for given Space name.

Parameters:

spaceName - The Name of the new Group Space

parentSpace - - the parent group space of the space being created.

baseTemplate - Template on which the space should be based upon

customAttributes - Attribute map for custom attributes (name,value) pairs

Returns:

Space class for a newly created Space

Throws:

SpacesException - Throws Exception if the API can not create a new Space based on given Space Template, or SpaceTemplate is not found

createGroupSpace

Space createGroupSpace(SpaceTemplate baseTemplate,
                       SpaceCreationOptions options)
                throws SpacesException

Create API creates a new Space object from an existing Space template. It calls the template's clone method to get the clone of the template and then constructs the Space Object out of it. It automatcally creates the MDS location for given Space name.

Parameters:

baseTemplate - Template on which the space should be based upon

options - SpaceCreationOptions the list of space parameters like displayName, description, keywords, access levels etc which will be set during the space creation

Returns:

Space class for a newly created Space

Throws:

SpacesException - Throws Exception if the API can not create a new Space based on given Space Template, or SpaceTemplate is not found

deleteGroupSpace

Space deleteGroupSpace(Space space)
                throws SpacesException

This API deletes the given Spaces metadata from MDS. It also removes entries for space object metadata customizations, preferences, security metatadata etc.

Parameters:

space - Space object to be deleted

Returns:

Space object that got deleted

Throws:

SpacesException - Throws Exception if given Space object is not found or it does not exist

getSpaces

java.util.List<Space> getSpaces(oracle.mds.core.MDSSession session,
                                oracle.mds.query.Condition queryCondition,
                                boolean subscribedOnly)
                         throws SpacesException

Deprecated. use getSpaces(SpacesQueryParameters)

This method returns the names of spaces matching the specified search pattern, searching among the spaces that are 'visible' to the specified user.

Parameters:

session - MDS session based on which to retrieve the data.

subscribedOnly - true if only the spaces that the user is member of are to be returned, false if the union of spaces the user is member of and the set of discoverable spaces are to be returned.

queryCondition - Search pattern that would match the names of the spaces that are to be returned by this method. null or empty string if this method should not perform any search but simply return the 'visible' spaces.

Returns:

list of spaces that are 'visible' to the specified user and which match the specified search pattern if any.

Throws:

SpacesException - If there is a problem fetching metadata.

getSpaces

java.util.List<Space> getSpaces(oracle.mds.query.Condition queryCondition,
                                boolean subscribedOnly)
                         throws SpacesException

Deprecated. use getSpaces(SpacesQueryParameters)

This method returns the names of spaces matching the specified search pattern, searching among the spaces that are 'visible' to the specified user.

Here 'visible' would mean either just the spaces that the user is subscribed to, or the subscribed spaces together with the spaces that are discoverable, depending upon the argument subscribedOnly. If subscribedOnly is true this method will return just the spaces the user is subscribed to, otherwise it will return the union of these and the discoverable spaces metadata.

Thsi API determines the userName from the context. If userName is null this method would assume it to be referring to the anonymous user. For example, userName of null and subscribedOnly false would return the list of discoverable spaces (because anonymous user would not be a member of any Space)

Parameters:

subscribedOnly - true if only the spaces that the user is member of are to be returned, false if the union of spaces the user is member of and the set of discoverable spaces are to be returned.

queryCondition - Search pattern that would match the names of the spaces that are to be returned by this method. null or empty string if this method should not perform any search but simply return the 'visible' spaces.

Returns:

list of spaces that are 'visible' to the specified user and which match the specified search pattern if any.

Throws:

SpacesException - If there is a problem fetching metadata.

getSpacesList

java.util.List<Space> getSpacesList(java.lang.String namePattern)
                             throws SpacesException

Deprecated. use getSpaces(SpacesQueryParameters)

get the list of spaces on which the user has access.

Parameters:

namePattern - to filter on. if null everything is returned.

Returns:

List of Space objects on which the currrent user has access.

Throws:

SpacesException

getPublicSpacesNamesList

java.util.List<java.lang.String> getPublicSpacesNamesList(java.lang.String namePattern)
                                                   throws SpacesException

Deprecated. use getSpaces(SpacesQueryParameters)

get a list of all public space names.

Parameters:

namePattern - to filter on. if null everything is returned.

Returns:

List of Space objects on which the currrent user has access.

Throws:

SpacesException

getUserSpacesNamesList

java.util.List<java.lang.String> getUserSpacesNamesList(java.lang.String namePattern)
                                                 throws SpacesException

Deprecated. use getSpaces(SpacesQueryParameters)

get the list of space names on which the user has access.

Parameters:

namePattern - to filter on. if null everything is returned.

Returns:

List of Space objects on which the currrent user has access.

Throws:

SpacesException

renameGroupSpace

void renameGroupSpace(java.lang.String oldSpaceName,
                      java.lang.String newSpaceName)
               throws SpacesException

This API changes the name of the existing space to a new name

Parameters:

oldSpaceName - Old Space Name

newSpaceName - New Space Name

Throws:

SpacesException

getSpaces

java.util.List<GSMetadata> getSpaces(SpacesQueryOptions sqo)
                              throws SpacesException

Deprecated. use getSpaces(SpacesQueryParameters)

get a list of space metadata base on the jpa implementation. this has pagination support with support for a startIndex and a batchSize.

Parameters:

sqo - space query object. results will be returned based on the space query object. this drives the where clause.

searchPattern - the search pattern, null or empty string can be passed in to skip the search pattern

startIndex -

batchSize -

Returns:

Throws:

SpacesException

getSpaces

java.util.List<GSMetadata> getSpaces(SpacesQueryParameters sq)
                              throws SpacesException

Evaluates a spaces query and returns a list of space metadata objects based on the result.

Parameters:

sq - Spaces query to be evaluated.

Returns:

List of space metadata objects based on the specified query.

Throws:

SpacesException - If any problem occurs while querying or retrieving the space metadata.

See Also:

#createSpacesQuery

getSpaceFromDisplayName

Space getSpaceFromDisplayName(java.lang.String displayName)
                       throws SpacesException

This API returns the Space object given its displayName

Parameters:

displayName - Gs displayName

Throws:

SpacesException

refreshGroupSpaceCache

Future refreshGroupSpaceCache(java.util.List<java.lang.String> spaceNames,
                              SpacesManager.UpdateType updateType,
                              boolean syncMode,
                              boolean cleanGSTableCache)
                       throws SpacesException

Deprecated.

This API refreshes the group space table. This api keeps the MDS repository and the spaces and header table in sync.

Parameters:

spaceNames - is a list of group space names. An empty list or null indicates that we need to updated all the group space.

updateType - there are 3 options METADATA - updates only metadata, SECURITY - updates only security, ALL - updates both space and security.

syncMode - - true runs the project in synchronous mode. In async mode new thread will be spawned to run the update process.

cleanGSTableCache - - should be set to true only in case of app import This attribute will delete all those group spaces in the target instance which were not availiable in the source instance.

Throws:

SpacesException - when error occurs while updating the header and detail repository.

getSpaceByScopeGUID

Space getSpaceByScopeGUID(java.lang.String GUID)
                   throws SpacesException

This API returns the Space object given its GUID

Parameters:

displayName - GUID the GUID

Returns:

Space object

Throws:

SpacesException

executeQuery

java.util.List<GSMetadata> executeQuery(PortalInstanceQuery query,
                                        ResultsOrder order,
                                        int limit,
                                        int start)

Execute Portal API query.

Parameters:

query - PortalInstanceQuery

order - ResultsOrder

int - limit

int - start

boolean - if true then return public portals only

Returns:

List of GSMetadata

getPortals

java.util.List<GSMetadata> getPortals(SpacesQueryOptions sqo)

Get the portals using the query options

Parameters:

sqo - the query options

Returns:

the metadata for the portals matching the query