org.gatein.wsrp.services

Interface ServiceFactory

All Known Subinterfaces:

ManageableServiceFactory

All Known Implementing Classes:

SOAPServiceFactory

public interface ServiceFactory

A factory that gives access to WSRP services published by a remote producer based on the metadata provided by its WSDL file. This WSDL file is parsed and analyzed to extract the supported WSRP version as well as individual Services information.

Version:

$Revision: 11484 $

Author:

Julien Viet

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_TIMEOUT_MS
static org.gatein.common.util.Version	WSRP1
static org.gatein.common.util.Version	WSRP2

Method Summary

Methods

Modifier and Type	Method and Description
void	enableWSS(boolean enable) Specifies whether WS-Security (WSS) is activated when accessing the services held by this ServiceFactory.
MarkupService	getMarkupService()
PortletManagementService	getPortletManagementService()
RegistrationService	getRegistrationService()
<T> T	getService(Class<T> clazz) Generic, typesafe version of the get*Service methods.
ServiceDescriptionService	getServiceDescriptionService()
String	getWsdlDefinitionURL() Retrieves the current String representation of the remote producer's WSDL URL.
int	getWSOperationTimeOut() Retrieves the current number of milliseconds this factory waits before deciding that a WS operation has timed out.
org.gatein.common.util.Version	getWSRPVersion() Returns the WSRP version of the remote service that this ServiceFactory connects to or null if the ServiceFactory is not available.
boolean	isAvailable() Determines whether or not this ServiceFactory is able to provide services.
boolean	isFailed() Determines whether or not this ServiceFactory is in a permanent state of failure which cannot be recovered from without user intervention.
boolean	isWSSAvailable() Determines whether WS-Security is configured and available to be enabled on this ServiceFactory.
boolean	isWSSEnabled() Retrieves whether WSS is enabled or not on this ServiceFactory
boolean	refresh(boolean force) Refreshes (if needed) the information held by this factory from the producer's WSDL.
void	setWsdlDefinitionURL(String wsdlDefinitionURL) Specifies the URL of the WSDL that needs to be analyzed for WSRP service publication.
void	setWSOperationTimeOut(int msBeforeTimeOut) Specifies how many milliseconds this factory waits before deciding a WS operation is considered as having timed out.
void	start() Performs initialization of this ServiceFactory based on available connection metadata.
void	stop() Performs any clean-up operation needed when this factory is being shutdown.

Field Detail

DEFAULT_TIMEOUT_MS

static final int DEFAULT_TIMEOUT_MS

See Also:

Constant Field Values

WSRP2

static final org.gatein.common.util.Version WSRP2

WSRP1

static final org.gatein.common.util.Version WSRP1

Method Detail

getService

<T> T getService(Class<T> clazz)
             throws Exception

Generic, typesafe version of the get*Service methods.

Type Parameters:

T - the generic type of the service we're trying to retrieve

Parameters:

clazz - the expected class of the service we're trying to retrieve

Returns:

the service instance associated with the specified type if any

Throws:

Exception - if the service couldn't be initialized or retrieved

isAvailable

boolean isAvailable()

Determines whether or not this ServiceFactory is able to provide services. A non-available ServiceFactory might be in a temporary state of non-availability (e.g. if the remote host is not currently reachable) or permanently (because, e.g. its configuration is invalid). Permanent failure is indicated by isFailed() status.

Returns:

true if this ServiceFactory is ready to provide services, false otherwise.

isFailed

boolean isFailed()

Determines whether or not this ServiceFactory is in a permanent state of failure which cannot be recovered from without user intervention. This notably happens if the configuration is incorrect (i.e. remote host URLs are invalid).

Returns:

true if this ServiceFactory is not configured properly, false otherwise.

start

void start()
           throws Exception

Performs initialization of this ServiceFactory based on available connection metadata.

Throws:

Exception - if initialization and connection to the remote service couldn't be performed.

stop

void stop()

Performs any clean-up operation needed when this factory is being shutdown.

setWsdlDefinitionURL

void setWsdlDefinitionURL(String wsdlDefinitionURL)

Specifies the URL of the WSDL that needs to be analyzed for WSRP service publication.

Parameters:

wsdlDefinitionURL - a String representation of the URL of the remote producer's WSDL

getWsdlDefinitionURL

String getWsdlDefinitionURL()

Retrieves the current String representation of the remote producer's WSDL URL.

Returns:

the current String representation of the remote producer's WSDL URL.

setWSOperationTimeOut

void setWSOperationTimeOut(int msBeforeTimeOut)

Specifies how many milliseconds this factory waits before deciding a WS operation is considered as having timed out.

Parameters:

msBeforeTimeOut - number of milliseconds to wait for a WS operation to return before timing out. Will be set to DEFAULT_TIMEOUT_MS if negative.

getWSOperationTimeOut

int getWSOperationTimeOut()

Retrieves the current number of milliseconds this factory waits before deciding that a WS operation has timed out.

Returns:

the current number of milliseconds this factory waits before deciding that a WS operation has timed out.

getServiceDescriptionService

ServiceDescriptionService getServiceDescriptionService()
                                                       throws Exception

Throws:

Exception

getMarkupService

MarkupService getMarkupService()
                               throws Exception

Throws:

Exception

getPortletManagementService

PortletManagementService getPortletManagementService()
                                                     throws Exception

Throws:

Exception

getRegistrationService

RegistrationService getRegistrationService()
                                           throws Exception

Throws:

Exception

getWSRPVersion

org.gatein.common.util.Version getWSRPVersion()

Returns the WSRP version of the remote service that this ServiceFactory connects to or null if the ServiceFactory is not available.

refresh

boolean refresh(boolean force)
                throws Exception

Refreshes (if needed) the information held by this factory from the producer's WSDL.

Parameters:

force - whether or not to force the refresh (i.e. retrieval and parsing of the WSDL information), regardless of potential cache

Returns:

true if a refresh occurred as a result of this operation, false otherwise

Throws:

Exception

enableWSS

void enableWSS(boolean enable)

Specifies whether WS-Security (WSS) is activated when accessing the services held by this ServiceFactory.

Parameters:

enable - true to activate WS-Security, false to disable it

isWSSEnabled

boolean isWSSEnabled()

Retrieves whether WSS is enabled or not on this ServiceFactory

Returns:

true if WSS is enable for this ServiceFactory, false otherwise

isWSSAvailable

boolean isWSSAvailable()

Determines whether WS-Security is configured and available to be enabled on this ServiceFactory. For WSS to be enabled, this method must first return true.

Returns:

true if WS-Security is configured and available, false otherwise