01: /*
02: * $Id: EndpointURI.java 10790 2008-02-12 20:53:32Z dfeist $
03: * --------------------------------------------------------------------------------------
04: * Copyright (c) MuleSource, Inc. All rights reserved. http://www.mulesource.com
05: *
06: * The software in this package is published under the terms of the CPAL v1.0
07: * license, a copy of which has been included with this distribution in the
08: * LICENSE.txt file.
09: */
10:
11: package org.mule.api.endpoint;
12:
13: import org.mule.api.lifecycle.Initialisable;
14:
15: import java.io.Serializable;
16: import java.net.URI;
17: import java.util.Properties;
18:
19: /**
20: * <code>EndpointURI</code> is used to determine how a message is sent or
21: * received. The url defines the protocol, the endpointUri destination of the message
22: * and optionally the endpoint to use when dispatching the event. Mule urls take the
23: * form of - protocol://[host]:[port]/[provider]/endpointUri or
24: * protocol://[host]:[port]/endpointUri i.e. vm://my.object or
25: * The protocol can be any of any conector registered with Mule. The
26: * endpoint name if specified must be the name of a register global endpoint The
27: * endpointUri can be any endpointUri recognised by the endpoint type.
28: *
29: */
30: public interface EndpointURI extends Serializable, Initialisable {
31:
32: String PROPERTY_ENDPOINT_NAME = "endpointName";
33: String PROPERTY_ENDPOINT_URI = "address";
34: String PROPERTY_CONNECTOR_NAME = "connector";
35: String PROPERTY_TRANSFORMERS = "transformers";
36: String PROPERTY_RESPONSE_TRANSFORMERS = "responseTransformers";
37:
38: String getAddress();
39:
40: String getFilterAddress();
41:
42: /**
43: * @deprecated This property is used by endpoint-identifiers, global-endpoints use ImmutableEndpoint.getName()
44: */
45: String getEndpointName();
46:
47: /**
48: * @deprecated This property is used by endpoint-identifiers, global-endpoints use ImmutableEndpoint.getName()
49: */
50: void setEndpointName(String name);
51:
52: Properties getParams();
53:
54: /**
55: * A reduced version of getParams() - drops some system parameters
56: */
57: Properties getUserParams();
58:
59: String getScheme();
60:
61: String getSchemeMetaInfo();
62:
63: String getFullScheme();
64:
65: String getAuthority();
66:
67: String getHost();
68:
69: int getPort();
70:
71: String getPath();
72:
73: String getQuery();
74:
75: String getUserInfo();
76:
77: String getTransformers();
78:
79: String getResponseTransformers();
80:
81: URI getUri();
82:
83: String getConnectorName();
84:
85: String getResourceInfo();
86:
87: String getUser();
88:
89: String getPassword();
90: }
|