View Javadoc

1   /*
2    * $Id: MuleProperties.java 19316 2010-09-02 22:48:32Z rossmason $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSoft, Inc.  All rights reserved.  http://www.mulesoft.com
5    *
6    * The software in this package is published under the terms of the CPAL v1.0
7    * license, a copy of which has been included with this distribution in the
8    * LICENSE.txt file.
9    */
10  
11  package org.mule.api.config;
12  
13  
14  /**
15   * <code>MuleProperties</code> is a set of constants pertaining to Mule properties.
16   */
17  public class MuleProperties
18  {
19      /**
20       * The prefix for any Mule-specific properties set on an event
21       */
22      public static final String PROPERTY_PREFIX = "MULE_";
23  
24      // End System properties
25  
26      /**
27       * *****************************************************************************
28       * MuleEvent Level properties
29       * *****************************************************************************
30       */
31      public static final String MULE_EVENT_PROPERTY = PROPERTY_PREFIX + "EVENT";
32      public static final String MULE_EVENT_TIMEOUT_PROPERTY = PROPERTY_PREFIX + "EVENT_TIMEOUT";
33      public static final String MULE_METHOD_PROPERTY = "method";
34  
35      // Deprecated. 'method' is now used consistently for all transports
36      // public static final String MULE_METHOD_PROPERTY = PROPERTY_PREFIX + "SERVICE_METHOD";
37      public static final String MULE_IGNORE_METHOD_PROPERTY = PROPERTY_PREFIX + "IGNORE_METHOD";
38      public static final String MULE_ENDPOINT_PROPERTY = PROPERTY_PREFIX + "ENDPOINT";
39      public static final String MULE_ORIGINATING_ENDPOINT_PROPERTY = PROPERTY_PREFIX + "ORIGINATING_ENDPOINT";
40      public static final String MULE_ERROR_CODE_PROPERTY = PROPERTY_PREFIX + "ERROR_CODE";
41      public static final String MULE_REPLY_TO_PROPERTY = PROPERTY_PREFIX + "REPLYTO";
42      /**
43       * Prevents processing of the ReplyTo property by the Service. This is useful
44       * if you're component routed the message somewhere else which processed the
45       * ReplyTo.
46       */
47      public static final String MULE_REPLY_TO_STOP_PROPERTY = PROPERTY_PREFIX + "REPLYTO_STOP";
48      public static final String MULE_USER_PROPERTY = PROPERTY_PREFIX + "USER";
49      public static final String MULE_ENCODING_PROPERTY = PROPERTY_PREFIX + "ENCODING";
50      public static final String MULE_REPLY_TO_REQUESTOR_PROPERTY = PROPERTY_PREFIX + "REPLYTO_REQUESTOR";
51      /**
52       * @deprecated This property is no longer needed and will be removed in the next major release
53       */
54      @Deprecated
55      public static final String MULE_SESSION_ID_PROPERTY = PROPERTY_PREFIX + "SESSION_ID";
56      public static final String MULE_SESSION_PROPERTY = PROPERTY_PREFIX + "SESSION";
57      public static final String MULE_MESSAGE_ID_PROPERTY = PROPERTY_PREFIX + "MESSAGE_ID";
58      public static final String MULE_CORRELATION_ID_PROPERTY = PROPERTY_PREFIX + "CORRELATION_ID";
59      public static final String MULE_CORRELATION_GROUP_SIZE_PROPERTY = PROPERTY_PREFIX + "CORRELATION_GROUP_SIZE";
60      public static final String MULE_CORRELATION_SEQUENCE_PROPERTY = PROPERTY_PREFIX + "CORRELATION_SEQUENCE";
61      public static final String MULE_REMOTE_SYNC_PROPERTY = PROPERTY_PREFIX + "REMOTE_SYNC";
62      public static final String MULE_REMOTE_CLIENT_ADDRESS = PROPERTY_PREFIX + "REMOTE_CLIENT_ADDRESS";
63      public static final String MULE_SOAP_METHOD = PROPERTY_PREFIX + "SOAP_METHOD";
64      public static final String MULE_JMS_SESSION = PROPERTY_PREFIX + "JMS_SESSION";
65      public static final String MULE_MANAGEMENT_CONTEXT_PROPERTY = PROPERTY_PREFIX + "MANAGEMENT_CONTEXT";
66      public static final String MULE_CREDENTIALS_PROPERTY = PROPERTY_PREFIX + "CREDENTIALS";
67      public static final String MULE_DISABLE_TRANSPORT_TRANSFORMER_PROPERTY = PROPERTY_PREFIX + "DISABLE_TRANSPORT_TRANSFORMER";
68      // End MuleEvent Level properties
69  
70      /**
71       * *****************************************************************************
72       * Generic Service descriptor properties
73       * *****************************************************************************
74       */
75      public static final String SERVICE_FINDER = "service.finder";
76  
77      /**
78       * *****************************************************************************
79       * Model Service descriptor properties
80       * *****************************************************************************
81       */
82      public static final String MODEL_CLASS = "model";
83  
84      /**
85       * *****************************************************************************
86       * Transport Service descriptor properties
87       * *****************************************************************************
88       */
89      public static final String CONNECTOR_CLASS = "connector";
90      public static final String CONNECTOR_MESSAGE_RECEIVER_CLASS = "message.receiver";
91      public static final String CONNECTOR_TRANSACTED_MESSAGE_RECEIVER_CLASS = "transacted.message.receiver";
92      public static final String CONNECTOR_XA_TRANSACTED_MESSAGE_RECEIVER_CLASS = "xa.transacted.message.receiver";
93      public static final String CONNECTOR_DISPATCHER_FACTORY = "dispatcher.factory";
94      public static final String CONNECTOR_REQUESTER_FACTORY = "requester.factory";
95      public static final String CONNECTOR_TRANSACTION_FACTORY = "transaction.factory";
96      public static final String CONNECTOR_MESSAGE_FACTORY = "message.factory";
97      public static final String CONNECTOR_INBOUND_TRANSFORMER = "inbound.transformer";
98      public static final String CONNECTOR_OUTBOUND_TRANSFORMER = "outbound.transformer";
99      public static final String CONNECTOR_RESPONSE_TRANSFORMER = "response.transformer";
100     public static final String CONNECTOR_ENDPOINT_BUILDER = "endpoint.builder";
101     public static final String CONNECTOR_SERVICE_FINDER = "service.finder";
102     public static final String CONNECTOR_SERVICE_ERROR = "service.error";
103     public static final String CONNECTOR_SESSION_HANDLER = "session.handler";
104     public static final String CONNECTOR_META_ENDPOINT_BUILDER = "meta.endpoint.builder";
105     public static final String CONNECTOR_INBOUND_EXCHANGE_PATTERNS = "inbound.exchange.patterns";
106     public static final String CONNECTOR_OUTBOUND_EXCHANGE_PATTERNS = "outbound.exchange.patterns";
107     public static final String CONNECTOR_DEFAULT_EXCHANGE_PATTERN = "default.exchange.pattern";
108     // End Connector Service descriptor properties
109 
110     public static final String MULE_WORKING_DIRECTORY_PROPERTY = "mule.working.dir";
111     public static final String MULE_HOME_DIRECTORY_PROPERTY = "mule.home";
112     public static final String APP_HOME_DIRECTORY_PROPERTY = "app.home";
113 
114     // Object Name Keys
115     public static final String OBJECT_MULE_CONTEXT = "_muleContext";
116     public static final String OBJECT_SYSTEM_MODEL = "_muleSystemModel";
117     public static final String OBJECT_MULE_CONTEXT_PROCESSOR = "_muleContextProcessor";
118     public static final String OBJECT_PROPERTY_PLACEHOLDER_PROCESSOR = "_mulePropertyPlaceholderProcessor";
119     public static final String OBJECT_OBJECT_NAME_PROCESSOR = "_muleObjectNameProcessor";
120     public static final String OBJECT_LIFECYCLE_MANAGER = "_muleLifecycleManager";
121     public static final String OBJECT_SECURITY_MANAGER = "_muleSecurityManager";
122     public static final String OBJECT_TRANSACTION_MANAGER = "_muleTransactionManager";
123     public static final String OBJECT_QUEUE_MANAGER = "_muleQueueManager";
124     public static final String OBJECT_MULE_APPLICATION_PROPERTIES = "_muleProperties";
125     public static final String OBJECT_MULE_ENDPOINT_FACTORY = "_muleEndpointFactory";
126     public static final String OBJECT_MULE_STREAM_CLOSER_SERVICE = "_muleStreamCloserService";
127     public static final String OBJECT_MULE_SIMPLE_REGISTRY_BOOTSTRAP = "_muleSimpleRegistryBootstrap";
128     public static final String OBJECT_DEFAULT_THREADING_PROFILE = "_defaultThreadingProfile";
129     public static final String OBJECT_DEFAULT_MESSAGE_DISPATCHER_THREADING_PROFILE = "_defaultMessageDispatcherThreadingProfile";
130     public static final String OBJECT_DEFAULT_MESSAGE_REQUESTER_THREADING_PROFILE = "_defaultMessageRequesterThreadingProfile";
131     public static final String OBJECT_DEFAULT_MESSAGE_RECEIVER_THREADING_PROFILE = "_defaultMessageReceiverThreadingProfile";
132     public static final String OBJECT_DEFAULT_SERVICE_THREADING_PROFILE = "_defaultServiceThreadingProfile";
133     public static final String OBJECT_DEFAULT_RETRY_POLICY_TEMPLATE = "_defaultRetryPolicyTemplate";
134     public static final String OBJECT_MULE_CONFIGURATION = "_muleConfiguration";
135     public static final String OBJECT_MULE_NAMESPACE_MANAGER = "_muleNamespaceManager";
136 
137     // Not currently used as these need to be instance variables of the MuleContext.
138     public static final String OBJECT_WORK_MANAGER = "_muleWorkManager";
139     public static final String OBJECT_NOTIFICATION_MANAGER = "_muleNotificationManager";
140 
141     /**
142      * Specifies whether mule should process messages synchronously, i.e. that a
143      * mule-model can only process one message at a time, or asynchronously. The
144      * default value is 'false'.
145      */
146     // TODO BL-76: remove me!
147     public static final String SYNCHRONOUS_PROPERTY = "synchronous";
148     public static final String EXCHANGE_PATTERN = "exchange-pattern";
149     public static final String EXCHANGE_PATTERN_CAMEL_CASE = "exchangePattern";
150 
151     /**
152      * The prefix for any Mule-specific properties set in the system properties
153      */
154     public static final String SYSTEM_PROPERTY_PREFIX = "mule.";
155     public static final String MULE_CONTEXT_PROPERTY = SYSTEM_PROPERTY_PREFIX + "context";
156     public static final String MULE_ENCODING_SYSTEM_PROPERTY = SYSTEM_PROPERTY_PREFIX + "encoding";
157 
158     public static final String CONTENT_TYPE_PROPERTY = "Content-Type";
159 
160 }