com.sapportals.portal.navigation

Interface INavigationConnectorRegistration

public interface INavigationConnectorRegistration

The interface that enables a navigation connectors and redirectors to register and unregister themself to the navigation service.

Method Summary

Set	getAllConnectorKeys() Get the keys the registered connectors keys
INavigationConnector	getConnector(String connectorKey) gGet connector by its key
void	registerConnector(String connectorKey, AbstractNavigationConnector connector) Registers a navigation connector to the navigation service.
void	registerConnector(String connectorKey, AbstractNavigationConnector connector, INavigationConnectorNamingHandler namingHandler) Registers a navigation connector with its naming handler to the navigation service.
void	registerConnector(String connectorKey, INavigationConnector connector) Deprecated. use registerConnector(String connectorKey, AbstractNavigationConnector connector)
void	registerConnector(String connectorKey, INavigationConnectorExt connector) Deprecated. use registerConnector(String connectorKey, AbstractNavigationConnector connector)
void	registerConnector(String connectorKey, INavigationConnectorExt connector, INavigationConnectorNamingHandler namingHandler) Deprecated. use registerConnector(String connectorKey, AbstractNavigationConnector connector, INavigationConnectorNamingHandler namingHandler)
void	registerConnector(String connectorKey, INavigationConnectorExt connector, INavigationConnectorNamingHandler namingHandler, Map redirectors) Deprecated. use registerConnector(String connectorKey, AbstractNavigationConnector connector, INavigationConnectorNamingHandler namingHandler), registerRedirector(String prefix, AbstractNavigationRedirector redirector)
void	registerConnector(String connectorKey, INavigationConnector connector, INavigationConnectorNamingHandler namingHandler) Deprecated. use registerConnector(String connectorKey, AbstractNavigationConnector connector, INavigationConnectorNamingHandler namingHandler)
void	registerConnector(String connectorKey, INavigationConnector connector, INavigationConnectorNamingHandler namingHandler, Map redirectors) Deprecated. use registerConnector(String connectorKey, AbstractNavigationConnector connector, INavigationConnectorNamingHandler namingHandler), registerRedirector(String prefix, AbstractNavigationRedirector redirector)
void	registerRedirector(String prefix, AbstractNavigationRedirector redirector) Registering one navigation redirector, that will be added to the redirectors general map.
void	registerRedirector(String redirectorPrefix, INavigationRedirector redirector) Deprecated. use registerRedirector(String redirectorPrefix, AbstractNavigationRedirector redirector)
void	registerRedirectors(Map redirectors) Deprecated. use registerRedirector(String redirectorPrefix, AbstractNavigationRedirector redirector)
void	unregisterConnector(String connectorKey) Unregisters a navigation connector from the navigation connectors context in the navigation service.
void	unregisterRedirector(String prefix) Unregisters a navigation redirector from the navigation redirectors context in the navigation service.

Method Detail

registerConnector

void registerConnector(String connectorKey,
                       INavigationConnector connector)

Deprecated. use registerConnector(String connectorKey, AbstractNavigationConnector connector)

Registers a navigation connector to the navigation service. The naming handler is the default naming handler implementation. The connector key is used as the prefix of the navigation nodes URLs.

Parameters:

connectorKey - a connector key

connector - a connector to register

registerConnector

void registerConnector(String connectorKey,
                       INavigationConnectorExt connector)

Deprecated. use registerConnector(String connectorKey, AbstractNavigationConnector connector)

Registers a navigation connector to the navigation service. The naming handler is the default naming handler implementation. The connector key is used as the prefix of the navigation nodes URLs.

Parameters:

connectorKey - a connector key

connector - a connector to register

registerConnector

void registerConnector(String connectorKey,
                       AbstractNavigationConnector connector)

Registers a navigation connector to the navigation service. The naming handler is the default naming handler implementation. The connector key is used as the prefix of the navigation nodes URLs.

Parameters:

connectorKey - a connector key

connector - a connector to register

registerConnector

void registerConnector(String connectorKey,
                       INavigationConnector connector,
                       INavigationConnectorNamingHandler namingHandler)

Deprecated. use registerConnector(String connectorKey, AbstractNavigationConnector connector, INavigationConnectorNamingHandler namingHandler)

Registers a navigation connector with its naming handler to the navigation service. The connector key is used as the prefix of the navigation nodes URLs.

Parameters:

connectorKey - a connector key

connector - a connector to register

namingHandler - a naming handler

registerConnector

void registerConnector(String connectorKey,
                       INavigationConnectorExt connector,
                       INavigationConnectorNamingHandler namingHandler)

Deprecated. use registerConnector(String connectorKey, AbstractNavigationConnector connector, INavigationConnectorNamingHandler namingHandler)

Registers a navigation connector with its naming handler to the navigation service. The connector key is used as the prefix of the navigation nodes URLs.

Parameters:

connectorKey - a connector key

connector - a connector to register

namingHandler - a naming handler

registerConnector

void registerConnector(String connectorKey,
                       AbstractNavigationConnector connector,
                       INavigationConnectorNamingHandler namingHandler)

Registers a navigation connector with its naming handler to the navigation service. The connector key is used as the prefix of the navigation nodes URLs.

Parameters:

connectorKey - a connector key

connector - a connector to register

namingHandler - a naming handler

registerConnector

void registerConnector(String connectorKey,
                       INavigationConnector connector,
                       INavigationConnectorNamingHandler namingHandler,
                       Map redirectors)

Deprecated. use registerConnector(String connectorKey, AbstractNavigationConnector connector, INavigationConnectorNamingHandler namingHandler), registerRedirector(String prefix, AbstractNavigationRedirector redirector)

Registers a navigation connector with its naming handler to the navigation service. The connector key is used as the prefix of the navigation nodes URLs.

Parameters:

connectorKey - a connector key

connector - a connector to register

namingHandler - a naming handler

redirectors - a map of redirector URLs

registerConnector

void registerConnector(String connectorKey,
                       INavigationConnectorExt connector,
                       INavigationConnectorNamingHandler namingHandler,
                       Map redirectors)

Deprecated. use registerConnector(String connectorKey, AbstractNavigationConnector connector, INavigationConnectorNamingHandler namingHandler), registerRedirector(String prefix, AbstractNavigationRedirector redirector)

Registers a navigation connector with its naming handler and redirector URLs to the navigation service.

Parameters:

connectorKey - a connector key

connector - a connector to register

namingHandler - a naming handler

redirectors - a map of redirector URLs

unregisterConnector

void unregisterConnector(String connectorKey)

Unregisters a navigation connector from the navigation connectors context in the navigation service.

Parameters:

connectorKey - connector key

registerRedirectors

void registerRedirectors(Map redirectors)

Deprecated. use registerRedirector(String redirectorPrefix, AbstractNavigationRedirector redirector)

Registering a map of navigation redirectors, that will be added to the redirectors general map. The redirector's map should contains pairs of :. Note that if a redirector already exists in the navigation redirectors map (a redirector with the same key was registered in the past) this redirector will be overriden by this one.

Parameters:

redirectors - map of : entries.

registerRedirector

void registerRedirector(String redirectorPrefix,
                        INavigationRedirector redirector)

Deprecated. use registerRedirector(String redirectorPrefix, AbstractNavigationRedirector redirector)

Registering one navigation redirector, that will be added to the redirectors general map. Note that if such a redirector already exists in the navigation redirectors map (a redirector with the same key was registered in the past) this redirector will be overriden by this one.

Parameters:

redirectorPrefix - a String that specify the redirector prefix.

redirector - an INavigationRedirector implementation.

unregisterRedirector

void unregisterRedirector(String prefix)

Unregisters a navigation redirector from the navigation redirectors context in the navigation service.

Parameters:

prefix -

registerRedirector

void registerRedirector(String prefix,
                        AbstractNavigationRedirector redirector)

Registering one navigation redirector, that will be added to the redirectors general map. Note that if such a redirector already exists in the navigation redirectors map (a redirector with the same key was registered in the past) this redirector will be overriden by this one.

Parameters:

prefix - a String that specify the redirector prefix.

redirector - an AbstractNavigationRedirector implementation.

getAllConnectorKeys

Set getAllConnectorKeys()

Get the keys the registered connectors keys

Returns:

Set of connector key

getConnector

INavigationConnector getConnector(String connectorKey)

gGet connector by its key

Parameters:

connectorKey - refers to the connector prefix as provided in the registry

Returns:

INavigationConnector

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