org.gatein.wsrp.services

Class SOAPServiceFactory

java.lang.Object

org.gatein.wsrp.services.SOAPServiceFactory

All Implemented Interfaces:

ManageableServiceFactory, ServiceFactory

public class SOAPServiceFactory
extends Object
implements ManageableServiceFactory

Version:

$Revision$

Author:

Chris Laprun

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	SOAPServiceFactory.WSDLInfo

Field Summary

Fields inherited from interface org.gatein.wsrp.services.ServiceFactory

DEFAULT_TIMEOUT_MS, WSRP1, WSRP2

Constructor Summary

Constructors

Constructor and Description
SOAPServiceFactory()

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	setAvailable(boolean available)
void	setFailed(boolean failed)
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.

Methods inherited from class java.lang.Object

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

Constructor Detail

SOAPServiceFactory

public SOAPServiceFactory()

Method Detail

getService

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

Description copied from interface: ServiceFactory

Generic, typesafe version of the get*Service methods.

Specified by:

getService in interface ServiceFactory

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

public boolean isAvailable()

Description copied from interface: ServiceFactory

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 ServiceFactory.isFailed() status.

Specified by:

isAvailable in interface ServiceFactory

Returns:

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

isFailed

public boolean isFailed()

Description copied from interface: ServiceFactory

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).

Specified by:

isFailed in interface ServiceFactory

Returns:

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

stop

public void stop()

Description copied from interface: ServiceFactory

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

Specified by:

stop in interface ServiceFactory

setFailed

public void setFailed(boolean failed)

Specified by:

setFailed in interface ManageableServiceFactory

setAvailable

public void setAvailable(boolean available)

Specified by:

setAvailable in interface ManageableServiceFactory

setWSOperationTimeOut

public void setWSOperationTimeOut(int msBeforeTimeOut)

Description copied from interface: ServiceFactory

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

Specified by:

setWSOperationTimeOut in interface ServiceFactory

Parameters:

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

getWSOperationTimeOut

public int getWSOperationTimeOut()

Description copied from interface: ServiceFactory

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

Specified by:

getWSOperationTimeOut in interface ServiceFactory

Returns:

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

getWsdlDefinitionURL

public String getWsdlDefinitionURL()

Description copied from interface: ServiceFactory

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

Specified by:

getWsdlDefinitionURL in interface ServiceFactory

Returns:

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

setWsdlDefinitionURL

public void setWsdlDefinitionURL(String wsdlDefinitionURL)

Description copied from interface: ServiceFactory

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

Specified by:

setWsdlDefinitionURL in interface ServiceFactory

Parameters:

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

start

public void start()
           throws Exception

Description copied from interface: ServiceFactory

Performs initialization of this ServiceFactory based on available connection metadata.

Specified by:

start in interface ServiceFactory

Throws:

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

getServiceDescriptionService

public ServiceDescriptionService getServiceDescriptionService()
                                                       throws Exception

Specified by:

getServiceDescriptionService in interface ServiceFactory

Throws:

Exception

getMarkupService

public MarkupService getMarkupService()
                               throws Exception

Specified by:

getMarkupService in interface ServiceFactory

Throws:

Exception

getPortletManagementService

public PortletManagementService getPortletManagementService()
                                                     throws Exception

Specified by:

getPortletManagementService in interface ServiceFactory

Throws:

Exception

getRegistrationService

public RegistrationService getRegistrationService()
                                           throws Exception

Specified by:

getRegistrationService in interface ServiceFactory

Throws:

Exception

getWSRPVersion

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

Description copied from interface: ServiceFactory

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

Specified by:

getWSRPVersion in interface ServiceFactory

refresh

public boolean refresh(boolean force)
                throws Exception

Description copied from interface: ServiceFactory

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

Specified by:

refresh in interface ServiceFactory

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

public void enableWSS(boolean enable)

Description copied from interface: ServiceFactory

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

Specified by:

enableWSS in interface ServiceFactory

Parameters:

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

isWSSEnabled

public boolean isWSSEnabled()

Description copied from interface: ServiceFactory

Retrieves whether WSS is enabled or not on this ServiceFactory

Specified by:

isWSSEnabled in interface ServiceFactory

Returns:

true if WSS is enable for this ServiceFactory, false otherwise

isWSSAvailable

public boolean isWSSAvailable()

Description copied from interface: ServiceFactory

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.

Specified by:

isWSSAvailable in interface ServiceFactory

Returns:

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