com.sap.portal.pcm.namingconventions

Interface INamingConventionsSrv

All Superinterfaces:

IService

Deprecated.

public interface INamingConventionsSrv
extends IService

The interface that represents the naming conventions service.

Field Summary

static String	ATTR_DEFAULT_XML_FILE Deprecated. A constant that indicates the name of the XML file used by the default handler.
static String	ATTR_HANDLER_CONFIGURATION Deprecated. A constant that indicates the configuration of the handler.
static String	ATTR_HANDLER_ID Deprecated. A constant that indicates the ID of the handler that is used by the service.
static String	ATTR_NAMING_CONVENTIONS_ACTIVE Deprecated. A constant that indicates the status of the naming conventions feature.
static String	HANDLER_CONFIG_BOTH Deprecated. A constant that indicates a value for a combination of both the default handler path and the default handler user configurations.
static String	HANDLER_CONFIG_PATH Deprecated. A constant that indicates a value for the default handler path configuration.
static String	HANDLER_CONFIG_USER Deprecated. A constant that indicates a value for the default handler user configuration.
static String	KEY Deprecated.

Method Summary

String[]	getAvailableNamespaces(com.sap.security.api.IPrincipal user, String path) Deprecated. Gets the available namespaces, specified by the service status, the selected handler and its configuration.
void	registerHandler(INamespacesHandler handler) Deprecated. Registers an external handler specified by its ID.
void	unRegisterHandler(String handlerID) Deprecated. Unregisters an external handler specified by its ID.

Methods inherited from interface com.sapportals.portal.prt.service.IService

afterInit, configure, destroy, getContext, getKey, init, release

Field Detail

KEY

static final String KEY

Deprecated.

See Also:

Constant Field Values

ATTR_HANDLER_ID

static final String ATTR_HANDLER_ID

Deprecated.

A constant that indicates the ID of the handler that is used by the service.

See Also:

Constant Field Values

ATTR_HANDLER_CONFIGURATION

static final String ATTR_HANDLER_CONFIGURATION

Deprecated.

A constant that indicates the configuration of the handler.
The default configuration specifies whether prefixes are based on the user or on the PCD path of the object.

See Also:

Constant Field Values

ATTR_NAMING_CONVENTIONS_ACTIVE

static final String ATTR_NAMING_CONVENTIONS_ACTIVE

Deprecated.

A constant that indicates the status of the naming conventions feature. true indicates the feature is active. false indicates the feature is not active.

See Also:

Constant Field Values

ATTR_DEFAULT_XML_FILE

static final String ATTR_DEFAULT_XML_FILE

Deprecated.

A constant that indicates the name of the XML file used by the default handler. The XML file is located in dist\xml.

See Also:

Constant Field Values

HANDLER_CONFIG_USER

static final String HANDLER_CONFIG_USER

Deprecated.

A constant that indicates a value for the default handler user configuration.

See Also:

Constant Field Values

HANDLER_CONFIG_PATH

static final String HANDLER_CONFIG_PATH

Deprecated.

A constant that indicates a value for the default handler path configuration.

See Also:

Constant Field Values

HANDLER_CONFIG_BOTH

static final String HANDLER_CONFIG_BOTH

Deprecated.

A constant that indicates a value for a combination of both the default handler path and the default handler user configurations.

See Also:

Constant Field Values

Method Detail

registerHandler

void registerHandler(INamespacesHandler handler)
                     throws RegistrationException

Deprecated.

Registers an external handler specified by its ID. Many handlers can be registered. The ID of the handler is used to set the link com.sap.portal.namespace.handler.id property.

Parameters:

handler - an external handler

Throws:

RegistrationException - if the registration fails

unRegisterHandler

void unRegisterHandler(String handlerID)

Deprecated.

Unregisters an external handler specified by its ID.

Parameters:

handlerID - a handler ID

getAvailableNamespaces

String[] getAvailableNamespaces(com.sap.security.api.IPrincipal user,
                                String path)
                                throws NoHandlerException,
                                       OperationFailedException

Deprecated.

Gets the available namespaces, specified by the service status, the selected handler and its configuration.
The service status is set in the link com.sap.portal.namespace.active property. If the service status value is false, the feature is not active and the method returns an empty array of Strings.
The selected handler ID is set in the com.sap.portal.namespace.handler.id property. The handler has to be registered using registerHandler. If no handler is specified, the default handler is invoked.
The configuration is set in the com.sap.portal.namespace.handler.configuration property. For the default handler, the following configurations are available:

• principal: Returns the available namespaces for the specified principal.
• path: Returns the available namespaces for the specified path.
• both: A combination of both configurations.

Parameters:

user - a user for which to get the namespace

path - a PCD ID

Returns:

an array of available namspaces

Throws:

NoHandlerException - if no handler is found for the selected handler ID

OperationFailedException - if the operation fails

Access Rights

This class can be accessed from:

SC	DC	Public Part	ACH
[sap.com] EP-RUNTIME	[sap.com] tc/ep/navigation/api	api	EP-PIN