TrapPeer

Class Overview

Interface used to maintain peer to peer Trap connections. In this case, the caller provides an out-of-band channel for Trap to handshake on.

Summary

[Expand] Inherited Constants

From interface com.ericsson.research.trap.TrapEndpoint String BLOCKING_BYTE_QUEUE Constant representing a blocking byte queue. String BLOCKING_MESSAGE_QUEUE Constant representing a blocking message queue. String OPTION_AUTO_HOSTNAME Hostname for automatic configuration. String OPTION_ENABLE_COMPRESSION Configuration parameter to enable/disable compression. String OPTION_LOGGERPREFIX Configuration parameter representing the prefix to be prepended to all logging out of this endpoint. String OPTION_MAX_CHUNK_SIZE Configuration parameter for the maximum chunk size. String REGULAR_BYTE_QUEUE Constant representing a non-blocking byte queue. String REGULAR_MESSAGE_QUEUE Constant representing a regular message queue.

[Expand] Inherited Methods
From interface com.ericsson.research.trap.TrapEndpoint abstract void close() Closes this Trap endpoint, terminating any outstanding Trap transports. abstract TrapAuthentication getAuthentication() Fetches the authentication instance for this Trap endpoint. abstract long getBlockingTimeout() Accessor for the current blocking timeout abstract TrapChannel getChannel(int channelID) Fetches the channel object associated with the given channel ID. abstract int getKeepaliveInterval() Retreives the current value of keepaliveInterval. abstract int getMaxActiveTransports() Gets the amount of maximum simultaneously active transports. abstract long getReconnectTimeout() Fetches the reconnect timeout. abstract TrapState getState() Accessor for the current endpoint state. abstract Map<String, Map<String, Object>> getTransportAuthenticationContexts() Fetches all the available authentication context, for all transports; including, where available, IP numbers, ports, etc. abstract TrapMessage.Format getTrapFormat() Fetches the current message serialization format. abstract Callback<Boolean> isAlive(long within, boolean check, boolean force, long timeout) Attempts to verify if the endpoint is alive, or has been alive within a certain number of milliseconds. abstract Callback<Boolean> isAlive(long timeout) Attempts to verify that the endpoint is alive, with a round trip time of at most timeout milliseconds. abstract boolean isAsync() Checks whether this endpoint works in async mode. abstract long lastAlive() Fetches the last known liveness timestamp of the endpoint. abstract void send(TrapObject object) Alias for send(TrapObject, int, boolean), with the channel ID set to 1. abstract void send(byte[] data, int channel, boolean useCompression) Attempts to queue data for sending. abstract void send(TrapObject object, int channel, boolean useCompression) Attempts to queue an object for sending. abstract void send(byte[] data) Alias for send(byte[], int, boolean), with the channel ID set to 1. abstract void setAsync(boolean async) In async mode, the endpoint will automatically schedule incoming messages on a separate thread than the one on which they are received. abstract void setAuthentication(TrapAuthentication authentication) Assigns an authentication instance to this TrapEndpoint. abstract void setBlockingTimeout(long timeout) Sets the blocking timeout, when using a blocking queue. abstract void setDelegate(TrapEndpointDelegate delegate, Object context) This method is deprecated. Since 1.1, the preferred signature is setDelegate(TrapDelegate, boolean). If a context is required, use the explicit setDelegateContext(Object) method. abstract void setKeepaliveExpiry(long newExpiry) Sets the keepalive expiry timeout. abstract void setKeepaliveInterval(int newInterval) Sets a new keepalive interval for the trap endpoint. abstract void setMaxActiveTransports(int newMax) Sets the maximum allowed simultaneous transports. abstract void setQueue(MessageQueue newQueue) Assigns a new queue implementation for the outgoing message queue. abstract void setQueueType(String type) Like setQueue(MessageQueue), except it instantiates one of the built-in queues based on default parameters. abstract void setReconnectTimeout(long reconnectTimeout) Sets the reconnect timeout. abstract void setTrapFormat(TrapMessage.Format trapFormat) Sets the Trap message format for this endpoint.
From interface com.ericsson.research.trap.TrapSettings abstract void configure(String configuration) Configures this TrapEndpoint, overwriting any previous configuration, and setting the new string to the new configuration. abstract void configureTransport(String transportName, String configurationKey, String configurationValue) Changes the configuration of a given transport. abstract void disableAllTransports() Convenience method to disable all transports at a given configurable object. abstract void disableTransport(String transportName) Disables a transport. abstract void enableTransport(String transportName) Enables a transport with a given name. abstract String getConfiguration() Gets the configuration of this endpoint. abstract TrapHostingTransport getHostingTransport(String protocol) Attempts to fetch a TrapHostingTransport instance for the specific protocol. abstract Collection<TrapHostingTransport> getHostingTransports() Ask the endpoint to make a list of the currently available TrapHostingTransports associated with it. abstract TrapTransport getTransport(String transportName) Accesses a single transport by name. abstract Collection<TrapTransport> getTransports() Gets the current set of transports associated with this TrapEndpoint. abstract boolean isTransportEnabled(String transportName) Queries if a transport is enabled. abstract void setDelegate(TrapDelegate delegate, boolean replaceAllExisting) Sets the object delegate as the listener for all the implemented TrapDelegate sub-interfaces. abstract void setDelegateContext(Object delegateContext) Trap delegates may have an additional context object provided at callback time. abstract void setOption(String optionName, String value) Sets a configuration option.