|
JBoss Remoting 3 3.2.14.GA-redhat-1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface Endpoint
A potential participant in a JBoss Remoting communications relationship.
This interface is part of the Remoting public API. It is intended to be consumed by Remoting applications; it is not intended to be implemented by them. Methods may be added to this interface in future minor releases without advance notice.
Nested Class Summary | |
---|---|
static class |
Endpoint.ListenerFlag
Flags which can be passed in to listener registration methods. |
Nested classes/interfaces inherited from interface org.jboss.remoting3.HandleableCloseable |
---|
HandleableCloseable.Key |
Method Summary | ||
---|---|---|
Registration |
addConnectionProvider(String uriScheme,
ConnectionProviderFactory providerFactory,
org.xnio.OptionMap optionMap)
Register a connection provider for a URI scheme. |
|
org.xnio.IoFuture<Connection> |
connect(String protocol,
SocketAddress bindAddress,
SocketAddress destination)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(String protocol,
SocketAddress bindAddress,
SocketAddress destination,
org.xnio.OptionMap connectOptions)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(String protocol,
SocketAddress bindAddress,
SocketAddress destination,
org.xnio.OptionMap connectOptions,
CallbackHandler callbackHandler)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(String protocol,
SocketAddress bindAddress,
SocketAddress destination,
org.xnio.OptionMap connectOptions,
CallbackHandler callbackHandler,
SSLContext sslContext)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(String protocol,
SocketAddress bindAddress,
SocketAddress destination,
org.xnio.OptionMap connectOptions,
CallbackHandler callbackHandler,
org.xnio.ssl.XnioSsl xnioSsl)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(String protocol,
SocketAddress bindAddress,
SocketAddress destination,
org.xnio.OptionMap connectOptions,
String userName,
String realmName,
char[] password)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(String protocol,
SocketAddress bindAddress,
SocketAddress destination,
org.xnio.OptionMap connectOptions,
String userName,
String realmName,
char[] password,
SSLContext sslContext)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(String protocol,
SocketAddress bindAddress,
SocketAddress destination,
org.xnio.OptionMap connectOptions,
String userName,
String realmName,
char[] password,
org.xnio.ssl.XnioSsl xnioSsl)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(URI destination)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(URI destination,
org.xnio.OptionMap connectOptions)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(URI destination,
org.xnio.OptionMap connectOptions,
CallbackHandler callbackHandler)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(URI destination,
org.xnio.OptionMap connectOptions,
CallbackHandler callbackHandler,
SSLContext sslContext)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(URI destination,
org.xnio.OptionMap connectOptions,
CallbackHandler callbackHandler,
org.xnio.ssl.XnioSsl xnioSsl)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(URI destination,
org.xnio.OptionMap connectOptions,
String userName,
String realmName,
char[] password)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(URI destination,
org.xnio.OptionMap connectOptions,
String userName,
String realmName,
char[] password,
SSLContext sslContext)
Open a connection with a peer. |
|
org.xnio.IoFuture<Connection> |
connect(URI destination,
org.xnio.OptionMap connectOptions,
String userName,
String realmName,
char[] password,
org.xnio.ssl.XnioSsl xnioSsl)
Open a connection with a peer. |
|
|
getConnectionProviderInterface(String uriScheme,
Class<T> expectedType)
Get the interface for a connection provider. |
|
String |
getName()
Get the name of this endpoint. |
|
org.xnio.XnioWorker |
getXnioWorker()
Get the XNIO worker configured for this endpoint. |
|
boolean |
isValidUriScheme(String uriScheme)
Determine whether the given URI scheme is valid for this endpoint. |
|
Registration |
registerService(String serviceType,
OpenListener openListener,
org.xnio.OptionMap optionMap)
Register a new service. |
Methods inherited from interface org.jboss.remoting3.HandleableCloseable |
---|
addCloseHandler, awaitClosed, awaitClosedUninterruptibly, close, closeAsync |
Methods inherited from interface org.jboss.remoting3.Attachable |
---|
getAttachments |
Method Detail |
---|
String getName()
null
if there is no nameRegistration registerService(String serviceType, OpenListener openListener, org.xnio.OptionMap optionMap) throws ServiceRegistrationException
serviceType
- the service typeopenListener
- the channel open listeneroptionMap
- the option map
ServiceRegistrationException
- if the service could not be registeredorg.xnio.IoFuture<Connection> connect(URI destination) throws IOException
connect EndpointPermission
to invoke this method.
destination
- the destination
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(URI destination, org.xnio.OptionMap connectOptions) throws IOException
connect EndpointPermission
to invoke this method.
destination
- the destinationconnectOptions
- options to configure this connection
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(URI destination, org.xnio.OptionMap connectOptions, CallbackHandler callbackHandler) throws IOException
connect EndpointPermission
to invoke this method.
destination
- the destinationconnectOptions
- options to configure this connectioncallbackHandler
- the local callback handler to use for authentication
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(URI destination, org.xnio.OptionMap connectOptions, CallbackHandler callbackHandler, SSLContext sslContext) throws IOException
connect EndpointPermission
to invoke this method.
destination
- the destinationconnectOptions
- options to configure this connectioncallbackHandler
- the local callback handler to use for authenticationsslContext
- the SSL context to use for SSL connections
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(URI destination, org.xnio.OptionMap connectOptions, CallbackHandler callbackHandler, org.xnio.ssl.XnioSsl xnioSsl) throws IOException
connect EndpointPermission
to invoke this method.
destination
- the destinationconnectOptions
- options to configure this connectioncallbackHandler
- the local callback handler to use for authenticationxnioSsl
- the SSL context to use for SSL connections
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(URI destination, org.xnio.OptionMap connectOptions, String userName, String realmName, char[] password) throws IOException
connect EndpointPermission
to invoke this method.
destination
- the destinationconnectOptions
- options to configure this connectionuserName
- the user name to authenticate as, or null
if it is unspecifiedrealmName
- the user realm to authenticate with, or null
if it is unspecifiedpassword
- the password to send, or null
if it is unspecified
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(URI destination, org.xnio.OptionMap connectOptions, String userName, String realmName, char[] password, SSLContext sslContext) throws IOException
connect EndpointPermission
to invoke this method.
destination
- the destinationconnectOptions
- options to configure this connectionuserName
- the user name to authenticate as, or null
if it is unspecifiedrealmName
- the user realm to authenticate with, or null
if it is unspecifiedpassword
- the password to send, or null
if it is unspecifiedsslContext
- the SSL context to use for SSL connections
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(URI destination, org.xnio.OptionMap connectOptions, String userName, String realmName, char[] password, org.xnio.ssl.XnioSsl xnioSsl) throws IOException
connect EndpointPermission
to invoke this method.
destination
- the destinationconnectOptions
- options to configure this connectionuserName
- the user name to authenticate as, or null
if it is unspecifiedrealmName
- the user realm to authenticate with, or null
if it is unspecifiedpassword
- the password to send, or null
if it is unspecifiedxnioSsl
- the SSL context to use for SSL connections
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(String protocol, SocketAddress bindAddress, SocketAddress destination) throws IOException
connect EndpointPermission
to invoke this method.
protocol
- the protocol to use for connectionbindAddress
- the address to bind to, or null
to choose one automatically as neededdestination
- the destination address, or null
if the protocol is not a network protocol
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(String protocol, SocketAddress bindAddress, SocketAddress destination, org.xnio.OptionMap connectOptions) throws IOException
connect EndpointPermission
to invoke this method.
protocol
- the protocol to use for connectionbindAddress
- the address to bind to, or null
to choose one automatically as neededdestination
- the destination address, or null
if the protocol is not a network protocolconnectOptions
- options to configure this connection
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(String protocol, SocketAddress bindAddress, SocketAddress destination, org.xnio.OptionMap connectOptions, CallbackHandler callbackHandler) throws IOException
connect EndpointPermission
to invoke this method.
protocol
- the protocol to use for connectionbindAddress
- the address to bind to, or null
to choose one automatically as neededdestination
- the destination address, or null
if the protocol is not a network protocolconnectOptions
- options to configure this connectioncallbackHandler
- the local callback handler to use for authentication
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(String protocol, SocketAddress bindAddress, SocketAddress destination, org.xnio.OptionMap connectOptions, CallbackHandler callbackHandler, SSLContext sslContext) throws IOException
connect EndpointPermission
to invoke this method.
protocol
- the protocol to use for connectionbindAddress
- the address to bind to, or null
to choose one automatically as neededdestination
- the destination address, or null
if the protocol is not a network protocolconnectOptions
- options to configure this connectioncallbackHandler
- the local callback handler to use for authenticationsslContext
- the SSL context to use for SSL connections
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(String protocol, SocketAddress bindAddress, SocketAddress destination, org.xnio.OptionMap connectOptions, CallbackHandler callbackHandler, org.xnio.ssl.XnioSsl xnioSsl) throws IOException
connect EndpointPermission
to invoke this method.
protocol
- the protocol to use for connectionbindAddress
- the address to bind to, or null
to choose one automatically as neededdestination
- the destination address, or null
if the protocol is not a network protocolconnectOptions
- options to configure this connectioncallbackHandler
- the local callback handler to use for authenticationxnioSsl
- the SSL context to use for SSL connections
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(String protocol, SocketAddress bindAddress, SocketAddress destination, org.xnio.OptionMap connectOptions, String userName, String realmName, char[] password) throws IOException
connect EndpointPermission
to invoke this method.
protocol
- the protocol to use for connectionbindAddress
- the address to bind to, or null
to choose one automatically as neededdestination
- the destination address, or null
if the protocol is not a network protocolconnectOptions
- options to configure this connectionuserName
- the user name to authenticate as, or null
if it is unspecifiedrealmName
- the user realm to authenticate with, or null
if it is unspecifiedpassword
- the password to send, or null
if it is unspecified
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(String protocol, SocketAddress bindAddress, SocketAddress destination, org.xnio.OptionMap connectOptions, String userName, String realmName, char[] password, SSLContext sslContext) throws IOException
connect EndpointPermission
to invoke this method.
protocol
- the protocol to use for connectionbindAddress
- the address to bind to, or null
to choose one automatically as neededdestination
- the destination address, or null
if the protocol is not a network protocolconnectOptions
- options to configure this connectionuserName
- the user name to authenticate as, or null
if it is unspecifiedrealmName
- the user realm to authenticate with, or null
if it is unspecifiedpassword
- the password to send, or null
if it is unspecifiedsslContext
- the SSL context to use for SSL connections
IOException
- if an error occurs while starting the connect attemptorg.xnio.IoFuture<Connection> connect(String protocol, SocketAddress bindAddress, SocketAddress destination, org.xnio.OptionMap connectOptions, String userName, String realmName, char[] password, org.xnio.ssl.XnioSsl xnioSsl) throws IOException
connect EndpointPermission
to invoke this method.
protocol
- the protocol to use for connectionbindAddress
- the address to bind to, or null
to choose one automatically as neededdestination
- the destination address, or null
if the protocol is not a network protocolconnectOptions
- options to configure this connectionuserName
- the user name to authenticate as, or null
if it is unspecifiedrealmName
- the user realm to authenticate with, or null
if it is unspecifiedpassword
- the password to send, or null
if it is unspecifiedxnioSsl
- the SSL context to use for SSL connections
IOException
- if an error occurs while starting the connect attemptRegistration addConnectionProvider(String uriScheme, ConnectionProviderFactory providerFactory, org.xnio.OptionMap optionMap) throws DuplicateRegistrationException, IOException
addConnectionProvider EndpointPermission
to invoke this method.
uriScheme
- the URI schemeproviderFactory
- the provider factoryoptionMap
- the configuration options for the connection provider
IOException
- if the provider failed to initialize
DuplicateRegistrationException
- if there is already a provider registered to that URI scheme<T> T getConnectionProviderInterface(String uriScheme, Class<T> expectedType) throws UnknownURISchemeException, ClassCastException
getConnectionProviderInterface EndpointPermission
to invoke this method.
T
- the expected type of the interfaceuriScheme
- the URI scheme of the registered connection providerexpectedType
- the expected type of the interface
UnknownURISchemeException
- if the given URI scheme is not registered
ClassCastException
- if the interface type does not match the expected typeboolean isValidUriScheme(String uriScheme)
uriScheme
- the URI scheme
true
if the URI scheme is valid at the time this method is calledorg.xnio.XnioWorker getXnioWorker()
|
JBoss Remoting 3 3.2.14.GA-redhat-1 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |