com.ibm.portal.resolver.service
Interface PocService

All Superinterfaces:

Disposable

All Known Subinterfaces:

PortalPocService, PortletPocService, PortletRenderPocService, PortletResourcePocService

public interface PocService
extends Disposable

Service that provides access to POC specific functionality. This service must be disposed by a call to Disposable.dispose() after it has been retrieved via its home interface.

Since:

6.0.1

See Also:

Disposable, PortalPocServiceHome, PortletPocServiceHome, CorPocServiceHome

Method Summary

Context	createContext() Deprecated.
java.net.URI	createURI(java.lang.String uri) Parses the URI string and creates a new URI object.
java.net.URI	createURI(java.lang.String scheme, java.lang.String schemeSpecificPart) Creates a new URI based on scheme and scheme specific part.
java.net.URI	createURI(java.net.URI uri) Creates a new URI based on an existing URI.
Context	getContext() Returns the COR Context for the environment that matches the service environment.
ContextAccessor	getContextAccessor() Returns access to information about the current access context.
LookupService	getLookupService() Deprecated. use PocServiceHome#getLookupService() instead
PocURLFactory	getURLFactory() Returns access to the URL generation functionality for POC URLs

Methods inherited from interface com.ibm.portal.Disposable

dispose

Method Detail

createContext

@Deprecated
Context createContext()

Deprecated.

Use getContext() instead.

createURI

java.net.URI createURI(java.lang.String uri)
                       throws java.net.URISyntaxException,
                              java.io.IOException

Parses the URI string and creates a new URI object.

Parameters:

uri - the URI string, not null

Returns:

the equivalent URI

Throws:

java.net.URISyntaxException

java.io.IOException

Since:

6.1.0

createURI

java.net.URI createURI(java.lang.String scheme,
                       java.lang.String schemeSpecificPart)
                       throws java.net.URISyntaxException

Creates a new URI based on scheme and scheme specific part. This method is preferable to the constructor of the URI object because it potentially caches frequently used URIs.

Parameters:

scheme - scheme, not null

schemeSpecificPart - scheme specific part, not null

Returns:

the URI

Throws:

java.net.URISyntaxException

Since:

6.1.0

createURI

java.net.URI createURI(java.net.URI uri)

Creates a new URI based on an existing URI. The purpose of this method is to provide a canonical mapping of URI object.s

Parameters:

uri - the original URI, not null

Returns:

the equivalent URI

Since:

6.1.0

getContext

Context getContext()

Returns the COR Context for the environment that matches the service environment. This context can be used to issue custom COR lookups.

Returns:

the COR context, not null

Since:

6.1.0

getContextAccessor

ContextAccessor getContextAccessor()

Returns access to information about the current access context.

Returns:

accessor to the context

Since:

6.1.0

getLookupService

@Deprecated
LookupService getLookupService()

Deprecated. use PocServiceHome#getLookupService() instead

Returns the default lookup service that can be used to discover the service endpoints for services associated with POC URIs. The implementation of this service will first try to locate a LookupService via the COR APIs. If this process fails, it will use a default implementation as a fallback. In order to access only the fallback implementation use an extension point lookup using the information in LookupService.

Returns:

default lookup service, not null

getURLFactory

PocURLFactory getURLFactory()

Returns access to the URL generation functionality for POC URLs

Returns:

factory to create POC URLs, not null