com.sapportals.portal.pcd.gl.admin

Interface IAdministration

public interface IAdministration

Administration functionality. This interface contains miscellaneous administration methods. It is not part of the published API, and thus may be changed from one release to another without warning.

This interface is not intended to be implemented by clients.

Method Summary

void	clonePersonalization(String sourcePrincipalId, List targetPrincipalIds, boolean overwrite) Deprecated. @deprecated use new JNDI provider for personalization (pcdpers:)
List	getConfigurationParameters() Returns a list of all config parameters that are used by the Pcd GL.
Properties	getConfigurationProperties() Returns the current PCD configuration as java.util.Properties
boolean	getIndexedSearchActive()
Integer[]	getIndexingInstanceIds() Finds all active and inactive instances' IDs, checks if an instance is off-line and marks it.
long	getIndexingStartupDelayMillis()
String	getIndexPolicy()
long	getInstanceDowntime()
List	getPersonalizedObjects(String principalId) Deprecated. use new JNDI provider for personalization (pcdpers:)
List	getPersonalizingPrincipalIds(String name, List principalIds) Deprecated. use @see com.sapportals.portal.pcd.gl.pers.IPersAdmin#getPersonalizingPrincipalIds(String name, List principalIds, Object securityPrincipal)
void	releaseCompleteCache() Removes the complete PCD cache.
void	removeObjectFromCache(String name) Removes the object that is bound to the given name from the PCD cache.
void	removeObjectFromCacheClusterWide(String name) Removes the object that is bound to the given name from the PCD cache cluster Wide.
void	removePersonalization(List principalIds, List objectIds) Deprecated. use new JNDI provider for personalization (pcdpers:)

Method Detail

removeObjectFromCache

void removeObjectFromCache(String name)
                           throws NamingException

Removes the object that is bound to the given name from the PCD cache.

Parameters:

name - The name (as instance of String)

Throws:

NamingException

releaseCompleteCache

void releaseCompleteCache()
                          throws NamingException

Removes the complete PCD cache. This function is only provided for test purposes and not intended for productive use!

Throws:

NamingException

removeObjectFromCacheClusterWide

void removeObjectFromCacheClusterWide(String name)
                                      throws NamingException

Removes the object that is bound to the given name from the PCD cache cluster Wide. This method does not affect the object of the given name if it is locked or being used.

Parameters:

name - The name in the PCD namespace (as instance of String)

Throws:

NamingException

getConfigurationParameters

List getConfigurationParameters()

Returns a list of all config parameters that are used by the Pcd GL.

Returns:

List

getConfigurationProperties

Properties getConfigurationProperties()

Returns the current PCD configuration as java.util.Properties

Returns:

the current PCD configuration

getPersonalizingPrincipalIds

@Deprecated
List getPersonalizingPrincipalIds(String name,
                                             List principalIds)
                                  throws NamingException

Deprecated. use @see com.sapportals.portal.pcd.gl.pers.IPersAdmin#getPersonalizingPrincipalIds(String name, List principalIds, Object securityPrincipal)

Returns a list of the unique principal ids which have personalized the PCD object specified by a name

Parameters:

name - The name in the PCD namespace without prefix (as instance of String)

principalIds - A List of principal ids to search for. If the parameter is null, all users will be returned. The list has to contain the unique principal ids as String.

Returns:

List

Throws:

NamingException

getPersonalizedObjects

@Deprecated
List getPersonalizedObjects(String principalId)
                            throws NamingException

Deprecated. use new JNDI provider for personalization (pcdpers:)

Returns the list object names (in PCD namespace) which are personalized by a given principal a name

Parameters:

principalId - The unique principal id as String

Returns:

List

Throws:

NamingException

removePersonalization

@Deprecated
void removePersonalization(List principalIds,
                                      List objectIds)
                           throws NamingException

Deprecated. use new JNDI provider for personalization (pcdpers:)

Removes the personalization for the given objects for all given principals

Parameters:

principalIds - The ids of the principals for which the personalization is to be removed. The list has to contain the unique principal ids as String. If the parameter is null, personalization will be removed for all principals.

objectIds - The names of the objects for which the personalization is to be removed. If the parameter is null, the personalization of all objects will be removed.

Throws:

NamingException

clonePersonalization

@Deprecated
void clonePersonalization(String sourcePrincipalId,
                                     List targetPrincipalIds,
                                     boolean overwrite)
                          throws NamingException

Deprecated. @deprecated use new JNDI provider for personalization (pcdpers:)

Copies the personalization for the given users

Parameters:

sourcePrincipalId - The id of the principals for which the personalization is to be copied. The list has to contain the unique principal ids as String.

targetPrincipalIds - The names of the principals to which the personalization is copied

overwrite -

Throws:

NamingException

getIndexPolicy

String getIndexPolicy()

Returns:

the indexPolicy

getInstanceDowntime

long getInstanceDowntime()

Returns:

the instance downtime

getIndexedSearchActive

boolean getIndexedSearchActive()

Returns:

true if indexed search is active

getIndexingInstanceIds

Integer[] getIndexingInstanceIds()

Finds all active and inactive instances' IDs, checks if an instance is off-line and marks it. If an instance is off-line for too much time, it is removed from the system, prompting a full crawl when it comes on-line again.

Returns:

all active and inactive instances' IDs

getIndexingStartupDelayMillis

long getIndexingStartupDelayMillis()

Returns:

the indexing startup delay in milliseconds

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/pcd/gl/api	-	EP-PIN
[sap.com] EP-BASIS-API	[sap.com] tc/epbc/pcd/gl/api	api	EP-PIN
[sap.com] KMC-WPC	[sap.com] tc/kmc/wpc/wpcfacade	api	EP-PIN-WPC-WCM
[sap.com] EP-BASIS	[sap.com] tc/epbc/pcd/pars/srvgldeprecated	api	BC-PIN-PCD