Package org.silverpeas.core.web.mvc.route

Class AbstractComponentInstanceRoutingMap

java.lang.Object

org.silverpeas.core.web.mvc.route.AbstractComponentInstanceRoutingMap

All Implemented Interfaces:

ComponentInstanceRoutingMap

Direct Known Subclasses:

AbstractCalendarInstanceRoutingMap

public abstract class AbstractComponentInstanceRoutingMap
extends Object
implements ComponentInstanceRoutingMap

Abstract implementation of ComponentInstanceRoutingMap which permits to handle as a centralized way the instanceId data.

Author:

silveryocha

Field Summary

Fields inherited from interface org.silverpeas.core.web.mvc.route.ComponentInstanceRoutingMap

NAME_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractComponentInstanceRoutingMap()

Method Summary

Modifier and Type	Method	Description
protected String	getBaseForPages()	Gets the base of a URI which brings the user to view or edit page.
URI	getEditionPage(ContributionIdentifier contributionIdentifier)	Gets the edition page URI of a resource handled by the component instance and represented by the given contribution identifier.
URI	getHomePage()	Gets the home page URI of the component instance.
String	getInstanceId()	Gets the identifier of the component instance which the current implementation is linked to.
URI	getPermalink(ContributionIdentifier contributionIdentifier)	Gets the permalink URI of a resource handled by the component instance and represented by the given contribution identifier.
URI	getViewPage(ContributionIdentifier contributionIdentifier)	Gets the view page URI of a resource handled by the component instance and represented by the given contribution identifier.
javax.ws.rs.core.UriBuilder	getWebResourceUriBuilder()	Gets the URI builder of WEB resource provided by the component instance.
protected javax.ws.rs.core.UriBuilder	newUriBuilder(String... paths)
protected javax.ws.rs.core.UriBuilder	uriBuilder(URI uri, String... paths)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractComponentInstanceRoutingMap

protected AbstractComponentInstanceRoutingMap()

Method Detail

getInstanceId

public String getInstanceId()

Description copied from interface: ComponentInstanceRoutingMap

Gets the identifier of the component instance which the current implementation is linked to.

Specified by:

getInstanceId in interface ComponentInstanceRoutingMap

Returns:

an identifier of component instance as string.

getHomePage

public URI getHomePage()

Description copied from interface: ComponentInstanceRoutingMap

Gets the home page URI of the component instance.

Specified by:

getHomePage in interface ComponentInstanceRoutingMap

Returns:

an URI instance.

getViewPage

public URI getViewPage(ContributionIdentifier contributionIdentifier)

Description copied from interface: ComponentInstanceRoutingMap

Gets the view page URI of a resource handled by the component instance and represented by the given contribution identifier.

Specified by:

getViewPage in interface ComponentInstanceRoutingMap

Parameters:

contributionIdentifier - a contribution identifier.

Returns:

an URI instance.

getEditionPage

public URI getEditionPage(ContributionIdentifier contributionIdentifier)

Description copied from interface: ComponentInstanceRoutingMap

Gets the edition page URI of a resource handled by the component instance and represented by the given contribution identifier.

Specified by:

getEditionPage in interface ComponentInstanceRoutingMap

Parameters:

contributionIdentifier - a contribution identifier.

Returns:

an URI instance.

getPermalink

public URI getPermalink(ContributionIdentifier contributionIdentifier)

Description copied from interface: ComponentInstanceRoutingMap

Gets the permalink URI of a resource handled by the component instance and represented by the given contribution identifier.

Specified by:

getPermalink in interface ComponentInstanceRoutingMap

Parameters:

contributionIdentifier - a contribution identifier.

Returns:

an URI instance.

getWebResourceUriBuilder

public javax.ws.rs.core.UriBuilder getWebResourceUriBuilder()

Description copied from interface: ComponentInstanceRoutingMap

Gets the URI builder of WEB resource provided by the component instance.

Specified by:

getWebResourceUriBuilder in interface ComponentInstanceRoutingMap

Returns:

a UriBuilder instance.

getBaseForPages

protected String getBaseForPages()

Gets the base of a URI which brings the user to view or edit page.

Returns:

the base of a URI as a string.

newUriBuilder

protected javax.ws.rs.core.UriBuilder newUriBuilder(String... paths)

uriBuilder

protected javax.ws.rs.core.UriBuilder uriBuilder(URI uri,
                                                 String... paths)