org.gatein.wsrp.consumer

Class RegistrationInfo

java.lang.Object

org.gatein.wsrp.consumer.RegistrationInfo

All Implemented Interfaces:

Serializable

public class RegistrationInfo
extends Object
implements Serializable

Records the registration status of the consumer owning this RegistrationInfo (via its ProducerInfo) with respect to the metadata provided by the producer, i.e. whether or not registration is required, whether the consumer is currently registered if needed, whether the currently available registration properties are consistent with the producer's expectations, whether the producer has changed its expectation since we last modified our registration properties and so if we need to modify our registration...

Since:

2.6

Version:

$Revision: 12686 $

Author:

Chris Laprun

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	RegistrationInfo.RegistrationRefreshResult

Constructor Summary

Constructors

Constructor and Description
RegistrationInfo(ProducerInfo producerInfo)
RegistrationInfo(ProducerInfo producerInfo, boolean requiresRegistration)
RegistrationInfo(RegistrationInfo other)

Method Summary

Methods

Modifier and Type	Method and Description
String	getConsumerAgent()
String	getConsumerName()
Long	getKey()
ProducerInfo	getParent()
RegistrationContext	getRegistrationContext()
RegistrationData	getRegistrationData() Retrieves the RegistrationData that can be sent to the WSRP producer associated with the consumer owning this RegistrationInfo to perform registration.
String	getRegistrationHandle()
Map<QName,RegistrationProperty>	getRegistrationProperties()
RegistrationProperty	getRegistrationProperty(QName name)
RegistrationProperty	getRegistrationProperty(String name)
byte[]	getRegistrationState()
boolean	hasLocalInfo()
Boolean	isConsistentWithProducerExpectations()
boolean	isModifiedSinceLastRefresh()
boolean	isModifyRegistrationNeeded()
boolean	isRefreshNeeded() Determines whether this RegistrationInfo needs to be refreshed when its refresh(org.oasis.wsrp.v2.ServiceDescription, String, boolean, boolean, boolean) method is called.
boolean	isRegistered()
boolean	isRegistrationDeterminedNotRequired() Determines whether it has been determined after querying the associated Producer that it does NOT require registration.
boolean	isRegistrationDeterminedRequired() Determines whether it has been determined after querying the associated Producer that it requires registration.
boolean	isRegistrationPropertiesExisting()
Boolean	isRegistrationRequired() Determines whether the associated Producer requires registration.
Boolean	isRegistrationValid()
boolean	isUndetermined()
void	propertyValueChanged(RegistrationProperty property, RegistrationProperty.Status previousStatus, Object oldValue, Object newValue) Only called if an actual change occurred, i.e.
RegistrationInfo.RegistrationRefreshResult	refresh(ServiceDescription serviceDescription, String producerId, boolean mergeWithLocalInfo, boolean forceRefresh, boolean forceCheckOfExtraProps) Refreshes the registration status and information required by the associated WSRP producer based on the information provided in the specified ServiceDescription.
void	removeRegistrationProperty(QName name)
void	removeRegistrationProperty(String name)
void	setConsumerName(String consumerName)
void	setKey(Long key)
void	setModifiedSinceLastRefresh(boolean modifiedSinceLastRefresh)
void	setParent(ProducerInfo parent)
void	setRegistrationContext(RegistrationContext registrationContext)
void	setRegistrationHandle(String registrationHandle)
void	setRegistrationProperties(Map<QName,RegistrationProperty> registrationProperties)
RegistrationProperty	setRegistrationPropertyValue(QName name, String value)
RegistrationProperty	setRegistrationPropertyValue(String name, String value)
void	setRegistrationState(byte[] registrationState)

Methods inherited from class java.lang.Object

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

Constructor Detail

RegistrationInfo

public RegistrationInfo(ProducerInfo producerInfo)

RegistrationInfo

public RegistrationInfo(ProducerInfo producerInfo,
                boolean requiresRegistration)

RegistrationInfo

public RegistrationInfo(RegistrationInfo other)

Method Detail

isUndetermined

public boolean isUndetermined()

getKey

public Long getKey()

setKey

public void setKey(Long key)

getRegistrationHandle

public String getRegistrationHandle()

setRegistrationHandle

public void setRegistrationHandle(String registrationHandle)

getRegistrationState

public byte[] getRegistrationState()

setRegistrationState

public void setRegistrationState(byte[] registrationState)

getParent

public ProducerInfo getParent()

setParent

public void setParent(ProducerInfo parent)

isRefreshNeeded

public boolean isRefreshNeeded()

Determines whether this RegistrationInfo needs to be refreshed when its refresh(org.oasis.wsrp.v2.ServiceDescription, String, boolean, boolean, boolean) method is called.

isRegistrationValid

public Boolean isRegistrationValid()

isConsistentWithProducerExpectations

public Boolean isConsistentWithProducerExpectations()

isRegistrationRequired

public Boolean isRegistrationRequired()

Determines whether the associated Producer requires registration.

Returns:

null if this RegistrationInfo hasn't queried the Producer yet and thus, doesn't have a definitive answer on whether or not the associated Producer requires registration, Boolean.TRUE if the associated Producer requires registration, Boolean.FALSE otherwise.

isRegistrationDeterminedRequired

public boolean isRegistrationDeterminedRequired()

Determines whether it has been determined after querying the associated Producer that it requires registration.

Returns:

true if and only if the associated Producer has been queried and mandates registration, false otherwise.

Throws:

IllegalStateException - if refresh(org.oasis.wsrp.v2.ServiceDescription, java.lang.String, boolean, boolean, boolean) has not yet been called

isRegistrationDeterminedNotRequired

public boolean isRegistrationDeterminedNotRequired()

Determines whether it has been determined after querying the associated Producer that it does NOT require registration.

Returns:

true if and only if the associated Producer has been queried and does NOT mandate registration, false otherwise.

Throws:

IllegalStateException - if refresh(org.oasis.wsrp.v2.ServiceDescription, java.lang.String, boolean, boolean, boolean) has not yet been called

hasLocalInfo

public boolean hasLocalInfo()

isRegistrationPropertiesExisting

public boolean isRegistrationPropertiesExisting()

getRegistrationData

public RegistrationData getRegistrationData()

Retrieves the RegistrationData that can be sent to the WSRP producer associated with the consumer owning this RegistrationInfo to perform registration.

getConsumerName

public String getConsumerName()

setConsumerName

public void setConsumerName(String consumerName)

getConsumerAgent

public String getConsumerAgent()

getRegistrationProperty

public RegistrationProperty getRegistrationProperty(String name)

getRegistrationProperty

public RegistrationProperty getRegistrationProperty(QName name)

setRegistrationPropertyValue

public RegistrationProperty setRegistrationPropertyValue(String name,
                                                String value)

setRegistrationPropertyValue

public RegistrationProperty setRegistrationPropertyValue(QName name,
                                                String value)

removeRegistrationProperty

public void removeRegistrationProperty(String name)

removeRegistrationProperty

public void removeRegistrationProperty(QName name)

getRegistrationProperties

public Map<QName,RegistrationProperty> getRegistrationProperties()

setRegistrationProperties

public void setRegistrationProperties(Map<QName,RegistrationProperty> registrationProperties)

refresh

public RegistrationInfo.RegistrationRefreshResult refresh(ServiceDescription serviceDescription,
                                                 String producerId,
                                                 boolean mergeWithLocalInfo,
                                                 boolean forceRefresh,
                                                 boolean forceCheckOfExtraProps)

Refreshes the registration status and information required by the associated WSRP producer based on the information provided in the specified ServiceDescription.

Parameters:

serviceDescription - the ServiceDescription to extract registration information from

producerId - the producer identifier associated with the ServiceDescription, used mainly for logging purposes

mergeWithLocalInfo - whether the information extracted from the ServiceDescription needs to be merged with any existing registration information already present in this RegistrationInfo prior to the refresh operation. This is useful to provide a clean view of expected registration properties as opposed to a view mixing both existing and missing expected information.

forceRefresh - whether or not we should force the refresh regardless of the cache status

forceCheckOfExtraProps -

Returns:

setRegistrationContext

public void setRegistrationContext(RegistrationContext registrationContext)

getRegistrationContext

public RegistrationContext getRegistrationContext()

isModifyRegistrationNeeded

public boolean isModifyRegistrationNeeded()

isModifiedSinceLastRefresh

public boolean isModifiedSinceLastRefresh()

setModifiedSinceLastRefresh

public void setModifiedSinceLastRefresh(boolean modifiedSinceLastRefresh)

propertyValueChanged

public void propertyValueChanged(RegistrationProperty property,
                        RegistrationProperty.Status previousStatus,
                        Object oldValue,
                        Object newValue)

Only called if an actual change occurred, i.e. oldvalue is guaranteed to be different from newValue

isRegistered

public boolean isRegistered()