org.gatein.wsrp.registration.mapping

Class ConsumerMapping

java.lang.Object

org.gatein.wsrp.registration.mapping.ConsumerMapping

All Implemented Interfaces:

BaseMapping<ConsumerSPI,JCRRegistrationPersistenceManager>

public abstract class ConsumerMapping
extends Object
implements BaseMapping<ConsumerSPI,JCRRegistrationPersistenceManager>

Version:

$Revision$

Author:

Chris Laprun

Field Summary

Fields

Modifier and Type	Field and Description
static String	NODE_NAME

Fields inherited from interface org.gatein.wsrp.jcr.mapping.BaseMapping

JCR_TYPE_NAME_CONSTANT_NAME

Constructor Summary

Constructors

Constructor and Description
ConsumerMapping()

Method Summary

Methods

Modifier and Type	Method and Description
RegistrationMapping	createAndAddRegistrationMappingFrom(Registration registration)
abstract RegistrationMapping	createRegistration(String path)
abstract ConsumerGroupMapping	findGroupById(String id)
abstract RegistrationMapping	findRegistrationById(String id)
abstract ConsumerCapabilitiesMapping	getCapabilities()
abstract String	getConsumerAgent()
abstract ConsumerGroupMapping	getGroup()
abstract String	getId()
Class<ConsumerSPI>	getModelClass() Retrieves the Java class of the model object this BaseMapping deals with.
abstract String	getName()
abstract String	getPersistentKey()
abstract List<RegistrationMapping>	getRegistrations()
void	initFrom(ConsumerSPI consumer) Initializes this BaseMapping from the data of the specified model object
abstract void	setConsumerAgent(String consumerAgent)
abstract void	setGroup(ConsumerGroupMapping group)
abstract void	setId(String id)
abstract void	setName(String name)
ConsumerSPI	toModel(ConsumerSPI initial, JCRRegistrationPersistenceManager persistenceManager) Converts this BaseMapping into a model object, creating a new one if needed or resetting the specified initial value to the persisted state.

Methods inherited from class java.lang.Object

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

Field Detail

NODE_NAME

public static final String NODE_NAME

See Also:

Constant Field Values

Constructor Detail

ConsumerMapping

public ConsumerMapping()

Method Detail

getPersistentKey

public abstract String getPersistentKey()

getName

public abstract String getName()

setName

public abstract void setName(String name)

getId

public abstract String getId()

setId

public abstract void setId(String id)

getConsumerAgent

public abstract String getConsumerAgent()

setConsumerAgent

public abstract void setConsumerAgent(String consumerAgent)

getRegistrations

public abstract List<RegistrationMapping> getRegistrations()

createRegistration

public abstract RegistrationMapping createRegistration(String path)

getGroup

public abstract ConsumerGroupMapping getGroup()

setGroup

public abstract void setGroup(ConsumerGroupMapping group)

getCapabilities

public abstract ConsumerCapabilitiesMapping getCapabilities()

findGroupById

public abstract ConsumerGroupMapping findGroupById(String id)

findRegistrationById

public abstract RegistrationMapping findRegistrationById(String id)

createAndAddRegistrationMappingFrom

public RegistrationMapping createAndAddRegistrationMappingFrom(Registration registration)

initFrom

public void initFrom(ConsumerSPI consumer)

Description copied from interface: BaseMapping

Initializes this BaseMapping from the data of the specified model object

Specified by:

initFrom in interface BaseMapping<ConsumerSPI,JCRRegistrationPersistenceManager>

Parameters:

consumer - the model object to initialize from

toModel

public ConsumerSPI toModel(ConsumerSPI initial,
                  JCRRegistrationPersistenceManager persistenceManager)

Description copied from interface: BaseMapping

Converts this BaseMapping into a model object, creating a new one if needed or resetting the specified initial value to the persisted state.

Specified by:

toModel in interface BaseMapping<ConsumerSPI,JCRRegistrationPersistenceManager>

Parameters:

initial - a potentially null initial value that will be reset to the persisted state

persistenceManager - the registry associated with instances of the specified model type

Returns:

a new model instance or the specified initial value reset to the persisted state

getModelClass

public Class<ConsumerSPI> getModelClass()

Description copied from interface: BaseMapping

Retrieves the Java class of the model object this BaseMapping deals with.

Specified by:

getModelClass in interface BaseMapping<ConsumerSPI,JCRRegistrationPersistenceManager>

Returns:

the Java class of the model object this BaseMapping deals with.