View Javadoc

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