Docjar: A Java Source and Docuemnt Enginecom.*    java.*    javax.*    org.*    all    new    plug-in

Quick Search    Search Deep

org.mule
Class MuleConfiguration  view MuleConfiguration download MuleConfiguration.java

java.lang.Object
  extended byorg.mule.MuleConfiguration

public class MuleConfiguration
extends java.lang.Object

MuleConfiguration holds the runtime configuration specific to the MuleManager. Once the MuleManager has been initialised this class is immutable.

Version:
$Revision: 1.2 $

Field Summary
static java.lang.String DEFAULT_INBOUND_PROVIDER
          Default value for INBOUND_PROVIDER_PROPERTY
static java.lang.String DEFAULT_INBOUND_PROVIDER_PROPERTY
          Determines the default inboundProvider that Mule uses to communicate between MuelUMO's when an inboundProvider is not specified on a mule.
static int DEFAULT_MAX_OUTSTANDING_MESSAGES
          Default value for MAX_OUTSTANDING_MESSAGES_PROPERTY
static long DEFAULT_MAX_THREAD_WAIT
          Default value for MAX_THREAD_WAIT_PROPERTY
static int DEFAULT_MAX_THREADS_ACTIVE
          Default value for MAX_THREADS_ACTIVE_PROPERTY
static int DEFAULT_MAX_THREADS_IDLE
          Default value for MAX_THREADS_IDLE_PROPERTY
static java.lang.String DEFAULT_OUTBOUND_PROVIDER
          Default value for OUTBOUND_PROVIDER_PROPERTY
static java.lang.String DEFAULT_OUTBOUND_PROVIDER_PROPERTY
          Determines the default outboundProvider that Mule uses to communicate between MuelUMO's when an outboundProvider is not specified on a mule.
static int DEFAULT_POOL_EXHAUSTED_ACTION
          Default value for POOL_EXHAUSTED_ACTION_PROPERTY
static boolean DEFAULT_SYNCHRONOUS
          Default value for SYNCHRONOUS_PROPERTY
private  java.lang.String inboundProvider
          holds the value for DEFAULT_INBOUND_PROVIDER
private  boolean initialised
          determines whether this object has been initialised.
static java.lang.String MAX_OUTSTANDING_MESSAGES_PROPERTY
          This specifies the default number of messages that can be queued for this component before it starts blocking.
static java.lang.String MAX_THREAD_WAIT_PROPERTY
          When the threadPoolExhaustedAction is setto 2 (WHEN_EXHAUSTED_BLOCK) this can specify the maximum milliseconds the pool should block before throwing a NoSuchElementException
static java.lang.String MAX_THREADS_ACTIVE_PROPERTY
          Controls the maximum number of Mule UMOs that can be borrowed from a Session at one time.
static java.lang.String MAX_THREADS_IDLE_PROPERTY
          Controls the maximum number of Mule UMOs that can sit idle in the pool at any time.
private  int maxOutstandingMessages
          holds the value for MAX_OUTSTANDING_MESSAGES
private  int maxThreadIdle
          holds the value for MAX_THREADS_IDLE
private  int maxThreadsActive
          holds the value for MAX_THREADS_ACTIVE
private  long maxThreadWait
          holds the value for MAX_THREAD_WAIT
private  java.lang.String outboundProvider
          holds the value for DEFAULT_OUTBOUND_PROVIDER
static java.lang.String POOL_EXHAUSTED_ACTION_PROPERTY
          Specifies the behaviour of the Mule UMO pool when the pool is exhausted: 0 (WHEN_EXHAUSTED_FAIL) : will throw a NoSuchElementException 1 (WHEN_EXHAUSTED_BLOCK): will block (invoke Object.wait(long) until a new or idle object is available.
private  byte poolExhaustedAction
          holds the value for POOL_EXHAUSTED_ACTION
static java.lang.String PROPERTY_PREFIX
          The prefix for any Mule-specific properties set in the system properties
private  boolean synchronous
          holds the value for SYNCHRONOUS
static java.lang.String SYNCHRONOUS_PROPERTY
          Specifies whether mule should process messages sysnchonously, i.e.
 
Constructor Summary
MuleConfiguration()
          Default constructor
 
Method Summary
 java.lang.String getDefaultInboundProvider()
           
 java.lang.String getDefaultOutboundProvider()
           
 int getMaxOutstandingMessages()
           
 int getMaxThreadIdle()
           
 int getMaxThreadsActive()
           
 long getMaxThreadWait()
           
 byte getPoolExhaustedAction()
           
 void init(java.lang.String maxThreadsActive, java.lang.String maxThreadIdle, java.lang.String maxThreadWait, java.lang.String poolExhaustedAction, java.lang.String synchronous, java.lang.String inboundProvider, java.lang.String outboundProvider, java.lang.String maxMessages)
           
 boolean isSynchronous()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

PROPERTY_PREFIX

public static final java.lang.String PROPERTY_PREFIX
The prefix for any Mule-specific properties set in the system properties

See Also:
Constant Field Values

MAX_THREADS_ACTIVE_PROPERTY

public static final java.lang.String MAX_THREADS_ACTIVE_PROPERTY
Controls the maximum number of Mule UMOs that can be borrowed from a Session at one time. When non-positive, there is no limit to the number of components that may be active at one time. When maxActive is exceeded, the pool is said to be exhausted. You can specify this value on the descriptor declaration. If none is set this value will be used.

See Also:
Constant Field Values

MAX_THREADS_IDLE_PROPERTY

public static final java.lang.String MAX_THREADS_IDLE_PROPERTY
Controls the maximum number of Mule UMOs that can sit idle in the pool at any time. When non-positive, there is no limit to the number of Mule UMOs that may be idle at one time. You can specify this value on the descriptor declaration. If none is set this value will be used. If this value is not set then a system default of '10' will be used.

See Also:
Constant Field Values

MAX_THREAD_WAIT_PROPERTY

public static final java.lang.String MAX_THREAD_WAIT_PROPERTY
When the threadPoolExhaustedAction is setto 2 (WHEN_EXHAUSTED_BLOCK) this can specify the maximum milliseconds the pool should block before throwing a NoSuchElementException

See Also:
Constant Field Values

POOL_EXHAUSTED_ACTION_PROPERTY

public static final java.lang.String POOL_EXHAUSTED_ACTION_PROPERTY
Specifies the behaviour of the Mule UMO pool when the pool is exhausted: 0 (WHEN_EXHAUSTED_FAIL) : will throw a NoSuchElementException 1 (WHEN_EXHAUSTED_BLOCK): will block (invoke Object.wait(long) until a new or idle object is available. 2 (WHEN_EXHAUSTED_GROW) : will create a new Mule and return it(essentially making maxActive meaningless.) If a positive maxThreadWait value is supplied, it will block for at most that many milliseconds, after which a NoSuchElementException will be thrown. If maxThraedWait is non-positive, it will block indefinitely.

See Also:
Constant Field Values

SYNCHRONOUS_PROPERTY

public static final java.lang.String SYNCHRONOUS_PROPERTY
Specifies whether mule should process messages sysnchonously, i.e. that a mule-model can only processone message at a time, or asynchonously. The default value is 'false'.

See Also:
Constant Field Values

DEFAULT_INBOUND_PROVIDER_PROPERTY

public static final java.lang.String DEFAULT_INBOUND_PROVIDER_PROPERTY
Determines the default inboundProvider that Mule uses to communicate between MuelUMO's when an inboundProvider is not specified on a mule. If this value is not specifed, Mule will create a default VM connection called 'muleVMInboundProvider' which will use a VMConnector.

See Also:
Constant Field Values

DEFAULT_OUTBOUND_PROVIDER_PROPERTY

public static final java.lang.String DEFAULT_OUTBOUND_PROVIDER_PROPERTY
Determines the default outboundProvider that Mule uses to communicate between MuelUMO's when an outboundProvider is not specified on a mule. If this value is not specifed, Mule will create a default VM connection called 'muleVMOutbound' which will use a VMConnector.

See Also:
Constant Field Values

MAX_OUTSTANDING_MESSAGES_PROPERTY

public static final java.lang.String MAX_OUTSTANDING_MESSAGES_PROPERTY
This specifies the default number of messages that can be queued for this component before it starts blocking.

See Also:
Constant Field Values

DEFAULT_MAX_THREADS_ACTIVE

public static final int DEFAULT_MAX_THREADS_ACTIVE
Default value for MAX_THREADS_ACTIVE_PROPERTY

See Also:
Constant Field Values

DEFAULT_MAX_THREADS_IDLE

public static final int DEFAULT_MAX_THREADS_IDLE
Default value for MAX_THREADS_IDLE_PROPERTY

See Also:
Constant Field Values

DEFAULT_MAX_THREAD_WAIT

public static final long DEFAULT_MAX_THREAD_WAIT
Default value for MAX_THREAD_WAIT_PROPERTY

See Also:
Constant Field Values

DEFAULT_POOL_EXHAUSTED_ACTION

public static final int DEFAULT_POOL_EXHAUSTED_ACTION
Default value for POOL_EXHAUSTED_ACTION_PROPERTY

See Also:
Constant Field Values

DEFAULT_SYNCHRONOUS

public static final boolean DEFAULT_SYNCHRONOUS
Default value for SYNCHRONOUS_PROPERTY

See Also:
Constant Field Values

DEFAULT_INBOUND_PROVIDER

public static final java.lang.String DEFAULT_INBOUND_PROVIDER
Default value for INBOUND_PROVIDER_PROPERTY

See Also:
Constant Field Values

DEFAULT_OUTBOUND_PROVIDER

public static final java.lang.String DEFAULT_OUTBOUND_PROVIDER
Default value for OUTBOUND_PROVIDER_PROPERTY

See Also:
Constant Field Values

DEFAULT_MAX_OUTSTANDING_MESSAGES

public static final int DEFAULT_MAX_OUTSTANDING_MESSAGES
Default value for MAX_OUTSTANDING_MESSAGES_PROPERTY

See Also:
Constant Field Values

maxThreadsActive

private int maxThreadsActive
holds the value for MAX_THREADS_ACTIVE


maxThreadIdle

private int maxThreadIdle
holds the value for MAX_THREADS_IDLE


maxThreadWait

private long maxThreadWait
holds the value for MAX_THREAD_WAIT


poolExhaustedAction

private byte poolExhaustedAction
holds the value for POOL_EXHAUSTED_ACTION


synchronous

private boolean synchronous
holds the value for SYNCHRONOUS


inboundProvider

private java.lang.String inboundProvider
holds the value for DEFAULT_INBOUND_PROVIDER


outboundProvider

private java.lang.String outboundProvider
holds the value for DEFAULT_OUTBOUND_PROVIDER


maxOutstandingMessages

private int maxOutstandingMessages
holds the value for MAX_OUTSTANDING_MESSAGES


initialised

private boolean initialised
determines whether this object has been initialised. Once it has it is immutable

Constructor Detail

MuleConfiguration

public MuleConfiguration()
Default constructor

Method Detail

init

public void init(java.lang.String maxThreadsActive,
                 java.lang.String maxThreadIdle,
                 java.lang.String maxThreadWait,
                 java.lang.String poolExhaustedAction,
                 java.lang.String synchronous,
                 java.lang.String inboundProvider,
                 java.lang.String outboundProvider,
                 java.lang.String maxMessages)

getDefaultInboundProvider

public java.lang.String getDefaultInboundProvider()

getDefaultOutboundProvider

public java.lang.String getDefaultOutboundProvider()

getMaxOutstandingMessages

public int getMaxOutstandingMessages()

isSynchronous

public boolean isSynchronous()

getMaxThreadIdle

public int getMaxThreadIdle()

getMaxThreadsActive

public int getMaxThreadsActive()

getMaxThreadWait

public long getMaxThreadWait()

getPoolExhaustedAction

public byte getPoolExhaustedAction()