org.objectweb.fractal.bf.connectors.jms
Class JmsStubContent

java.lang.Object
  org.objectweb.fractal.bf.connectors.common.AbstractStubContent
      org.objectweb.fractal.bf.connectors.common.uri.UriStubContent
          org.objectweb.fractal.bf.connectors.jms.JmsStubContent

All Implemented Interfaces:

org.objectweb.fractal.api.control.AttributeController, org.objectweb.fractal.api.control.LifeCycleController, org.objectweb.fractal.bf.connectors.common.StubContentAttributes, org.objectweb.fractal.bf.connectors.common.uri.UriStubContentAttributes, JmsAttributes, JmsStubContentAttributes

public abstract class JmsStubContent
extends org.objectweb.fractal.bf.connectors.common.uri.UriStubContent
implements JmsStubContentAttributes

A super class for JMS stubs. Concrete classes are generated on the fly.

Field Summary

Fields inherited from class org.objectweb.fractal.bf.connectors.common.AbstractStubContent

log, remoteRef

Fields inherited from interface org.objectweb.fractal.api.control.LifeCycleController

STARTED, STOPPED

Constructor Summary

JmsStubContent()

Method Summary

String	getCorrelationScheme() Gets the correlation scheme used by the stub/skeleton: messageID, correlationID or none
String	getCreateDestinationMode() Gets the mode used to create destination: always, never, or ifNotExist
String	getDestinationType() Gets the type of the created destination: queue or topic.
String	getJndiConnectionFactoryName() Gets the JNDI name of the connection factory to use.
String	getJndiDestinationName() Gets the JNDI name of the destination to use.
String	getJndiInitialContextFactory() Gets the JNDI initial context factory.
String	getJndiResponseDestinationName() Gets the JNDI name of the destination on which responses will be send.
String	getJndiURL() Get the jndiURL used to configure the stub/skeleton.
boolean	getPersistent() Gets if messages sent by the stub/skeleton are persistent.
int	getPriority() Gets the priority of messages sent by the stub/skeleton.
String	getSelector() Gets the selector used to consume messages.
long	getTimeToLive() Gets the living time of messages sent by the stub/skeleton.
protected Object	resolveReference() Build a JMS client.
void	setCorrelationScheme(String correlationScheme) Sets the correlation scheme used by the stub/skeleton: messageID, correlationID or none
void	setCreateDestinationMode(String createDestinationMode) Sets the mode used to create destination always, never, or ifNotExist
void	setDestinationType(String destinationType) Sets the type of the created destination: queue or topic.
void	setJndiConnectionFactoryName(String jndiConnFactName) Sets the JNDI name of the connection factory to use.
void	setJndiDestinationName(String jndiDestinationName) Sets the JNDI name of the destination to use.
void	setJndiInitialContextFactory(String jndiInitialContextFactory) Sets the JNDI initial context factory.
void	setJndiResponseDestinationName(String jndiResponseDestinationName) Sets the JNDI name of the destination on which responses will be send.
void	setJndiURL(String jndiURL) Set the jndiURL used to configure the stub/skeleton.
void	setPersistent(boolean persistent) Sets the persistence of messages sent by the stub/skeleton.
void	setPriority(int priority) Sets the priority of messages sent by the stub/skeleton.
void	setSelector(String selector) Sets the selector used to consume messages.
void	setTimeToLive(long timeToLive) Sets the living time of messages sent by the stub/skeleton.
void	startFc()
void	stopFc()

Methods inherited from class org.objectweb.fractal.bf.connectors.common.uri.UriStubContent

getUri, setUri

Methods inherited from class org.objectweb.fractal.bf.connectors.common.AbstractStubContent

getFcState, getServiceClass, setServiceClass

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.objectweb.fractal.bf.connectors.common.uri.UriStubContentAttributes

getUri, setUri

Methods inherited from interface org.objectweb.fractal.bf.connectors.common.StubContentAttributes

getServiceClass, setServiceClass

Constructor Detail

JmsStubContent

public JmsStubContent()

Method Detail

getCorrelationScheme

public String getCorrelationScheme()

Description copied from interface: JmsAttributes

Gets the correlation scheme used by the stub/skeleton: messageID, correlationID or none

Specified by:

getCorrelationScheme in interface JmsAttributes

Returns:

the correlation scheme

See Also:

JmsAttributes.getCorrelationScheme()

setCorrelationScheme

public void setCorrelationScheme(String correlationScheme)

Description copied from interface: JmsAttributes

Sets the correlation scheme used by the stub/skeleton: messageID, correlationID or none

Specified by:

setCorrelationScheme in interface JmsAttributes

Parameters:

correlationScheme - the correlation scheme

See Also:

JmsAttributes.setCorrelationScheme(String)

getJndiDestinationName

public String getJndiDestinationName()

Description copied from interface: JmsAttributes

Gets the JNDI name of the destination to use.

Specified by:

getJndiDestinationName in interface JmsAttributes

Returns:

the JNDI name of the destination to use.

See Also:

JmsAttributes.getJndiDestinationName()

setJndiDestinationName

public void setJndiDestinationName(String jndiDestinationName)

Description copied from interface: JmsAttributes

Sets the JNDI name of the destination to use.

Specified by:

setJndiDestinationName in interface JmsAttributes

Parameters:

jndiDestinationName - the JNDI name of the destination.

See Also:

JmsAttributes.setJndiDestinationName(String)

getCreateDestinationMode

public String getCreateDestinationMode()

Description copied from interface: JmsAttributes

Gets the mode used to create destination: always, never, or ifNotExist

Specified by:

getCreateDestinationMode in interface JmsAttributes

Returns:

the mode used to create destination.

See Also:

JmsAttributes.getCreateDestinationMode()

setCreateDestinationMode

public void setCreateDestinationMode(String createDestinationMode)

Description copied from interface: JmsAttributes

Sets the mode used to create destination always, never, or ifNotExist

Specified by:

setCreateDestinationMode in interface JmsAttributes

Parameters:

createDestinationMode - the mode used to create destination.

See Also:

JmsAttributes.setCreateDestinationMode(String)

getDestinationType

public String getDestinationType()

Description copied from interface: JmsAttributes

Gets the type of the created destination: queue or topic.

Specified by:

getDestinationType in interface JmsAttributes

Returns:

the type of the created destination.

See Also:

JmsAttributes.getDestinationType()

setDestinationType

public void setDestinationType(String destinationType)

Description copied from interface: JmsAttributes

Sets the type of the created destination: queue or topic.

Specified by:

setDestinationType in interface JmsAttributes

Parameters:

destinationType - the type of the created destination.

See Also:

JmsAttributes.setDestinationType(String)

getJndiInitialContextFactory

public String getJndiInitialContextFactory()

Description copied from interface: JmsAttributes

Gets the JNDI initial context factory.

Specified by:

getJndiInitialContextFactory in interface JmsAttributes

Returns:

the JNDI initial context factory.

See Also:

JmsAttributes.getJndiInitialContextFactory()

setJndiInitialContextFactory

public void setJndiInitialContextFactory(String jndiInitialContextFactory)

Description copied from interface: JmsAttributes

Sets the JNDI initial context factory.

Specified by:

setJndiInitialContextFactory in interface JmsAttributes

Parameters:

jndiInitialContextFactory - the JNDI initial context factory.

See Also:

JmsAttributes.setJndiInitialContextFactory(String)

getJndiConnectionFactoryName

public String getJndiConnectionFactoryName()

Description copied from interface: JmsAttributes

Gets the JNDI name of the connection factory to use.

Specified by:

getJndiConnectionFactoryName in interface JmsAttributes

Returns:

the JNDI name of the connection factory to use.

See Also:

JmsAttributes.getJndiConnectionFactoryName()

setJndiConnectionFactoryName

public void setJndiConnectionFactoryName(String jndiConnFactName)

Description copied from interface: JmsAttributes

Sets the JNDI name of the connection factory to use.

Specified by:

setJndiConnectionFactoryName in interface JmsAttributes

Parameters:

jndiConnFactName - the JNDI name of the connection factory.

See Also:

JmsAttributes.setJndiConnectionFactoryName(String)

getPriority

public int getPriority()

Description copied from interface: JmsAttributes

Gets the priority of messages sent by the stub/skeleton.

Specified by:

getPriority in interface JmsAttributes

Returns:

the priority of messages sent by the stub/skeleton.

See Also:

JmsAttributes.getPriority()

setPriority

public void setPriority(int priority)

Description copied from interface: JmsAttributes

Sets the priority of messages sent by the stub/skeleton.

Specified by:

setPriority in interface JmsAttributes

Parameters:

priority - the priority of messages sent by the stub/skeleton.

See Also:

JmsAttributes.setPriority(int)

getTimeToLive

public long getTimeToLive()

Description copied from interface: JmsAttributes

Gets the living time of messages sent by the stub/skeleton.

Specified by:

getTimeToLive in interface JmsAttributes

Returns:

the living time of messages sent by the stub/skeleton.

See Also:

JmsAttributes.getTimeToLive()

setTimeToLive

public void setTimeToLive(long timeToLive)

Description copied from interface: JmsAttributes

Sets the living time of messages sent by the stub/skeleton.

Specified by:

setTimeToLive in interface JmsAttributes

Parameters:

timeToLive - the living time of messages sent by the stub/skeleton.

See Also:

JmsAttributes.setTimeToLive(long)

getSelector

public String getSelector()

Description copied from interface: JmsAttributes

Gets the selector used to consume messages.

Specified by:

getSelector in interface JmsAttributes

Returns:

the selector used when consume messages.

See Also:

JmsAttributes.getSelector()

setSelector

public void setSelector(String selector)

Description copied from interface: JmsAttributes

Sets the selector used to consume messages.

Specified by:

setSelector in interface JmsAttributes

Parameters:

selector - the selector used to consume messages.

See Also:

JmsAttributes.setSelector(String)

getPersistent

public boolean getPersistent()

Description copied from interface: JmsAttributes

Gets if messages sent by the stub/skeleton are persistent.

Specified by:

getPersistent in interface JmsAttributes

Returns:

true if messages sent by the stub/skeleton are persistent.

See Also:

JmsAttributes.getPersistent()

setPersistent

public void setPersistent(boolean persistent)

Description copied from interface: JmsAttributes

Sets the persistence of messages sent by the stub/skeleton.

Specified by:

setPersistent in interface JmsAttributes

Parameters:

persistent - true if messages sent by the stub/skeleton must be persistent.

See Also:

JmsAttributes.setPersistent(boolean)

getJndiURL

public String getJndiURL()

Description copied from interface: JmsAttributes

Get the jndiURL used to configure the stub/skeleton.

Specified by:

getJndiURL in interface JmsAttributes

Returns:

the jndiURL used to configure the stub/skeleton.

See Also:

JmsAttributes.getJndiURL()

setJndiURL

public void setJndiURL(String jndiURL)

Description copied from interface: JmsAttributes

Set the jndiURL used to configure the stub/skeleton.

Specified by:

setJndiURL in interface JmsAttributes

See Also:

JmsAttributes.setJndiURL(String)

getJndiResponseDestinationName

public String getJndiResponseDestinationName()

Description copied from interface: JmsAttributes

Gets the JNDI name of the destination on which responses will be send.

Specified by:

getJndiResponseDestinationName in interface JmsAttributes

Returns:

the JNDI name of the response destination

See Also:

JmsAttributes.getJndiResponseDestinationName()

setJndiResponseDestinationName

public void setJndiResponseDestinationName(String jndiResponseDestinationName)

Description copied from interface: JmsAttributes

Sets the JNDI name of the destination on which responses will be send.

Specified by:

setJndiResponseDestinationName in interface JmsAttributes

Parameters:

jndiResponseDestinationName - the JNDI name of the response destination

See Also:

JmsAttributes.setJndiResponseDestinationName(String)

startFc

public void startFc()
             throws org.objectweb.fractal.api.control.IllegalLifeCycleException

Specified by:

startFc in interface org.objectweb.fractal.api.control.LifeCycleController

Overrides:

startFc in class org.objectweb.fractal.bf.connectors.common.AbstractStubContent

Throws:

org.objectweb.fractal.api.control.IllegalLifeCycleException

See Also:

LifeCycleController.startFc()

stopFc

public void stopFc()

Specified by:

stopFc in interface org.objectweb.fractal.api.control.LifeCycleController

Overrides:

stopFc in class org.objectweb.fractal.bf.connectors.common.AbstractStubContent

See Also:

LifeCycleController.stopFc()

resolveReference

protected final Object resolveReference()

Build a JMS client.

Specified by:

resolveReference in class org.objectweb.fractal.bf.connectors.common.AbstractStubContent

Returns:

the object instantiated.