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