View Javadoc

1   /*
2    * $Id: UMOEndpointURI.java 7976 2007-08-21 14:26:13Z dirk.olmes $
3    * --------------------------------------------------------------------------------------
4    * Copyright (c) MuleSource, Inc.  All rights reserved.  http://www.mulesource.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.umo.endpoint;
12  
13  import java.io.Serializable;
14  import java.net.URI;
15  import java.util.Properties;
16  
17  /**
18   * <code>UMOEndpointURI</code> is used to determine how a message is sent or
19   * received. The url defines the protocol, the endpointUri destination of the message
20   * and optionally the endpoint to use when dispatching the event. Mule urls take the
21   * form of - protocol://[host]:[port]/[provider]/endpointUri or
22   * protocol://[host]:[port]/endpointUri i.e. vm://my.object or
23   * The protocol can be any of any conector registered with Mule. The
24   * endpoint name if specified must be the name of a register global endpoint The
25   * endpointUri can be any endpointUri recognised by the endpoint type.
26   * 
27   */
28  public interface UMOEndpointURI extends Serializable
29  {
30      String PROPERTY_ENDPOINT_NAME = "endpointName";
31      String PROPERTY_ENDPOINT_URI = "address";
32      String PROPERTY_CREATE_CONNECTOR = "createConnector";
33      String PROPERTY_CONNECTOR_NAME = "connector";
34      String PROPERTY_TRANSFORMERS = "transformers";
35      String PROPERTY_RESPONSE_TRANSFORMERS = "responseTransformers";
36  
37      String getAddress();
38  
39      String getFilterAddress();
40  
41      /** 
42       * @deprecated This property is used by endpoint-identifiers, global-endpoints use UMOImmutableEndpoint.getName()
43       */
44      String getEndpointName();
45  
46      /** 
47       * @deprecated This property is used by endpoint-identifiers, global-endpoints use UMOImmutableEndpoint.getName()
48       */
49      void setEndpointName(String name);
50  
51      Properties getParams();
52  
53      Properties getUserParams();
54  
55      String getScheme();
56  
57      String getSchemeMetaInfo();
58  
59      String getFullScheme();
60  
61      String getAuthority();
62  
63      String getHost();
64  
65      int getPort();
66  
67      String getPath();
68  
69      String getQuery();
70  
71      String getUserInfo();
72  
73      String getTransformers();
74  
75      String getResponseTransformers();
76  
77      int getCreateConnector();
78  
79      URI getUri();
80  
81      String getConnectorName();
82  
83      String getResourceInfo();
84  
85      String getUsername();
86  
87      String getPassword();
88  }