Skip navigation links
A B C D E G H I L M N O P Q R S T U 

A

addData(byte) - Method in interface com.adaptris.oftp.NSDU
Add a byte of data to this Nsdu prior to initialisation.
addData(byte[]) - Method in interface com.adaptris.oftp.NSDU
Add an array of data to this Nsdu prior to initialisation.
addMessage(OftpMessage) - Method in class com.adaptris.oftp.MessageStack
Add a message to the stack.

B

blockCount() - Method in interface com.adaptris.oftp.DataBufferGenerator
Get a count of the number of blocks that will make up the message.

C

canReceive() - Method in class com.adaptris.oftp.Mode
Can this mode receive data.
canSend() - Method in class com.adaptris.oftp.Mode
Can this mode send data.
CD - Static variable in class com.adaptris.oftp.CmdType
The CD CmdType.
CDT - Static variable in class com.adaptris.oftp.CmdType
The CDT CmdType.
check(OftpMessage) - Method in class com.adaptris.core.oftp.OftpPollingConsumer
 
check(OftpMessage) - Method in interface com.adaptris.oftp.MessageListener
Check that the destination in the start of file header is valid.
checkUser(String, String) - Method in class com.adaptris.core.oftp.SimpleUserManager
 
checkUser(String, String) - Method in interface com.adaptris.oftp.UserManager
Check if the user and password is valid.
close() - Method in class com.adaptris.core.oftp.OftpProducer
 
close() - Method in class com.adaptris.transport.ppp.PppSocketTransport
 
close() - Method in class com.adaptris.transport.TcpSocketTransport
 
close() - Method in class com.adaptris.transport.Transport
Close this transport and free any underlying resources.
close() - Method in interface com.adaptris.transport.TransportLayer
Close the underlying transport layer.
CmdType - Class in com.adaptris.oftp
An NSDU Command Type.
com.adaptris.core.oftp - package com.adaptris.core.oftp
Implementation of the core AdaptrisConsumer and AdaptrisProducer interface providing oftp transport functionality.
com.adaptris.core.transport - package com.adaptris.core.transport
Configuration classes that can be used to wrap the com.adaptris.transport package.
com.adaptris.oftp - package com.adaptris.oftp
Base package for handling communications via OFTP.
com.adaptris.transport - package com.adaptris.transport
The Adaptris Transport package contains all the relevant code used to handle a direct connection to a remote machine.
com.adaptris.transport.ppp - package com.adaptris.transport.ppp
Package containing PPP socket transport functionality.
commit() - Method in class com.adaptris.oftp.MessageStack
Commit any unsent messages.
config - Variable in class com.adaptris.transport.TcpSocketTransport
The configuration object.
CONFIG_ALWAYS_TRUST - Static variable in interface com.adaptris.transport.SocketConstants
Always trust the server.
CONFIG_BLOCKSIZE - Static variable in interface com.adaptris.transport.SocketConstants
The key within the configuration containing the blocksize to be passed to the TransportLayer.
CONFIG_BUFFER_CREDIT - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration containing the the buffer credit..
CONFIG_BUFFERSIZE - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration containing the the buffer size.
CONFIG_CLIENT_AUTH - Static variable in interface com.adaptris.transport.SocketConstants
Require Client Authoriation.
CONFIG_COMPRESSION - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration containing the compression flag.
CONFIG_CONNECTION_TYPE - Static variable in class com.adaptris.oftp.OftpConstants
The connection type.
CONFIG_HOST - Static variable in interface com.adaptris.transport.SocketConstants
The key within the configuration containing the name of the remote host.
CONFIG_ID - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration containing the the initiator id.
CONFIG_KEYSTORE_FILE - Static variable in interface com.adaptris.transport.TransportConstants
The key within the configuration containing the keystore.
CONFIG_KEYSTORE_PW - Static variable in interface com.adaptris.transport.TransportConstants
The key within the configuration containing the keystore password.
CONFIG_LISTEN - Static variable in interface com.adaptris.transport.SocketConstants
The key within the configuration containing the listen port.
CONFIG_LISTEN_TIMEOUT - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration containing how long each attempt should be when listening for connections.
CONFIG_MODE - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration containing the mode flag.
CONFIG_PASSWORD - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration containing the the initiator password.
CONFIG_PORT - Static variable in interface com.adaptris.transport.SocketConstants
The key within the configuration containing the name of the remote port.
CONFIG_PRIVATE_KEY_PW - Static variable in interface com.adaptris.transport.TransportConstants
The key within the configuration containing the private key password.
CONFIG_RELEASE_LEVEL - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration containing the release Level.
CONFIG_RESTART - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration containing the restart flag.
CONFIG_RFC2204 - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration which specifies rfc2204 (tcp mode) compatibility.
CONFIG_SPECIAL_LOGIC - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration containing the specialLogic flag.
CONFIG_STORAGE_ALL - Static variable in class com.adaptris.oftp.OftpConstants
ALL formats allowed.
CONFIG_STORAGE_FIXED - Static variable in class com.adaptris.oftp.OftpConstants
Fixed file format.
CONFIG_STORAGE_FORMAT - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration containing the accepted storage formats.
CONFIG_STORAGE_MAXSIZE - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration containing the maximum file size in 1K blocks.
CONFIG_STORAGE_TEXT - Static variable in class com.adaptris.oftp.OftpConstants
Text format.
CONFIG_STORAGE_UNSTRUCTURED - Static variable in class com.adaptris.oftp.OftpConstants
Unstructured format.
CONFIG_STORAGE_VARIABLE - Static variable in class com.adaptris.oftp.OftpConstants
Variable file format.
CONFIG_TIMEOUT - Static variable in interface com.adaptris.transport.SocketConstants
The key within the configuration containing the length of the timeout to be passed to the transport Layer.
CONFIG_USER_FIELD - Static variable in class com.adaptris.oftp.OftpConstants
The key within the configuration containing the user field.
connect() - Method in class com.adaptris.oftp.OftpClient
Make the connection to the remote OFTP Server.
connect() - Method in class com.adaptris.transport.ppp.PppSocketTransport
 
connect() - Method in class com.adaptris.transport.SSLSocketTransport
 
connect() - Method in class com.adaptris.transport.TcpSocketTransport
 
connect() - Method in class com.adaptris.transport.Transport
Make a connection.
CR - Static variable in class com.adaptris.oftp.OftpConstants
A Carriage return
create(String) - Static method in class com.adaptris.transport.Transport
Create a new instance of a Transport.
createDataStore() - Method in class com.adaptris.core.oftp.OftpDataStore
Return the configured datastore.
createDataStore() - Method in class com.adaptris.core.oftp.SimpleOftpDataStore
 
createTransport() - Method in class com.adaptris.core.transport.PppTcpClientConnection
 
createTransport() - Method in class com.adaptris.core.transport.TcpClientConnection
 
createTransport() - Method in class com.adaptris.core.transport.TransportConfig
The transport package is traditionally configured using properties.

D

DATA - Static variable in class com.adaptris.oftp.CmdType
The DATA CmdType.
DataBuffer - Interface in com.adaptris.oftp
Interface defining key attributes of all Datablocks.
DataBufferGenerator - Interface in com.adaptris.oftp
Splits a sequence of bytes into parts that are suitable for sending via OFTP.

E

EERP - Static variable in class com.adaptris.oftp.CmdType
The EERP CmdType.
EERP - Static variable in class com.adaptris.oftp.OftpMessage
An EERP
EFID - Static variable in class com.adaptris.oftp.CmdType
The EFID CmdType.
EFNA - Static variable in class com.adaptris.oftp.CmdType
The EFNA CmdType.
EFNA_ACCESS_FAILURE - Static variable in exception com.adaptris.oftp.OftpException
EFNA Access method failure
EFNA_DUPLICATE_FILE - Static variable in exception com.adaptris.oftp.OftpException
EFNA Duplicate File
EFNA_INVALID_BYTE_COUNT - Static variable in exception com.adaptris.oftp.OftpException
EFNA Invalid Byte count
EFNA_INVALID_DESTINATION - Static variable in exception com.adaptris.oftp.OftpException
EFNA invalid destination
EFNA_INVALID_FILENAME - Static variable in exception com.adaptris.oftp.OftpException
EFNA invalid filename
EFNA_INVALID_ORIGIN - Static variable in exception com.adaptris.oftp.OftpException
EFNA invalid origin
EFNA_INVALID_RECORD - Static variable in exception com.adaptris.oftp.OftpException
EFNA maximum record length not support
EFNA_INVALID_RECORD_COUNT - Static variable in exception com.adaptris.oftp.OftpException
EFNA Invalid record count
EFNA_INVALID_STORAGE - Static variable in exception com.adaptris.oftp.OftpException
EFNA storage record format not supported
EFNA_TOO_BIG - Static variable in exception com.adaptris.oftp.OftpException
EFNA file size is too big
EFNA_UNSPECIFIED - Static variable in exception com.adaptris.oftp.OftpException
EFNA Unspecified reason
EFPA - Static variable in class com.adaptris.oftp.CmdType
The EFPA CmdType.
enableTrace(boolean) - Method in class com.adaptris.oftp.OftpConfig
Force Extra Debugging.
equals(char) - Method in class com.adaptris.oftp.CmdType
Simple Equality based on the command char.
equals(Object) - Method in class com.adaptris.oftp.OftpMessage
 
ESID - Static variable in class com.adaptris.oftp.CmdType
The ESID CmdType.
ESID_COMMAND_INVALID - Static variable in exception com.adaptris.oftp.OftpException
Command contained invalid data.
ESID_COMMAND_UNRECOGNISED - Static variable in exception com.adaptris.oftp.OftpException
Command not recognised.
ESID_INCOMPATIBLE - Static variable in exception com.adaptris.oftp.OftpException
Mode of capabilities incompatible.
ESID_INVALID_PW - Static variable in exception com.adaptris.oftp.OftpException
Invalid PW.
ESID_LOCAL_EMERGENCY - Static variable in exception com.adaptris.oftp.OftpException
Local site emergency closedown.
ESID_NORMAL - Static variable in exception com.adaptris.oftp.OftpException
Normal ESID there has been no error.
ESID_NSDU_ERROR - Static variable in exception com.adaptris.oftp.OftpException
NSDU size error.
ESID_PROTOCOL_VIOLATION - Static variable in exception com.adaptris.oftp.OftpException
Protocol violoation.
ESID_RESOURCE_UNAVAILABLE - Static variable in exception com.adaptris.oftp.OftpException
Resources not available.
ESID_TIME_OUT - Static variable in exception com.adaptris.oftp.OftpException
Time out.
ESID_UNSPECIFIED - Static variable in exception com.adaptris.oftp.OftpException
Unspecified abort code.
ESID_USER_UNKNOWN - Static variable in exception com.adaptris.oftp.OftpException
User Unknown.
ExceptionListener - Interface in com.adaptris.oftp
Interface for handling exceptions that occur during an OFTP session.

G

getAcceptedFormats() - Method in class com.adaptris.core.oftp.OftpConnection
Get the configured AcceptedFormat.
getAcceptedFormats() - Method in class com.adaptris.oftp.OftpConfig
Get the accepted file formats
getAlwaysTrust() - Method in class com.adaptris.transport.SSLSocketTransport
Get the always trust value.
getBlockCount() - Method in class com.adaptris.oftp.OftpMessage
Get the number of 1k blocks in the message
getBlockSize() - Method in class com.adaptris.core.transport.TransportConfig
Get the blocksize.
getBlockSize() - Method in class com.adaptris.transport.TcpSocketTransport
Get the blocksize.
getBytes() - Method in class com.adaptris.oftp.OftpMessage
Get the bytes stored in the message
getCheckConnectionCommand() - Method in class com.adaptris.core.transport.PppTcpClientConnection
Get the command for checking a connection.
getCheckConnectionCommand() - Method in class com.adaptris.transport.ppp.PppSocketTransport
Get the command for checking a connection.
getCmd() - Method in class com.adaptris.oftp.CmdType
Get the command associated with this type.
getCmdType() - Method in interface com.adaptris.oftp.NSDU
Get the CmdType specified by this NSDU.
getCommandLength(char) - Static method in class com.adaptris.oftp.CmdType
Return the length of the specified command
getConfig() - Method in class com.adaptris.oftp.OftpClient
Get the configuration created by the constructor.
getConfig() - Method in class com.adaptris.oftp.OftpServer
Get the configuration created by the constructor.
getConnectCommand() - Method in class com.adaptris.core.transport.PppTcpClientConnection
Return the configured connect command.
getConnectCommand() - Method in class com.adaptris.transport.ppp.PppSocketTransport
Return the configured connect command.
getConnectTimeout() - Method in class com.adaptris.transport.TcpSocketTransport
Get the connect timeout.
getData() - Method in interface com.adaptris.oftp.DataBuffer
Get the actual data associated with this data buffer.
getDataStore() - Method in class com.adaptris.core.oftp.OftpConnection
Get the configured datastore.
getDataStore() - Method in class com.adaptris.oftp.OftpConfig
Get the underlying datastore.
getDate() - Method in class com.adaptris.oftp.OftpMessage
Get the date for the SFID
getDescription() - Method in class com.adaptris.oftp.CmdType
Get the description of the command.
getDestination() - Method in class com.adaptris.oftp.OftpMessage
Get the destination of this message
getDisconnectCommand() - Method in class com.adaptris.core.transport.PppTcpClientConnection
Get the configured disconnect command.
getDisconnectCommand() - Method in class com.adaptris.transport.ppp.PppSocketTransport
Get the configured disconnect command.
getException() - Method in class com.adaptris.oftp.OftpMessage
Get the exception associated with this message if any.
getExceptionListener() - Method in class com.adaptris.oftp.OftpConfig
Get the listener handling exceptions
getFileFormat() - Method in class com.adaptris.oftp.OftpMessage
Get the fileformat of this OftpMessage as specified by the SFID
getFileName() - Method in class com.adaptris.core.oftp.SimpleOftpDataStore
Get the filename to use.
getFriendlyMessage(int) - Static method in exception com.adaptris.oftp.OftpException
Get a friendly error message for the exception.
getFriendlyMessage(OftpException) - Static method in exception com.adaptris.oftp.OftpException
Get a friendly error message for the exception.
getHeaderBlockCount() - Method in class com.adaptris.oftp.OftpMessage
Get the number of 1k blocks in the message according to the SFID
getHost() - Method in class com.adaptris.core.transport.TcpClientConnection
Get the host to connect to.
getHost() - Method in class com.adaptris.transport.TcpSocketTransport
Get the host to connect to
getId() - Method in class com.adaptris.oftp.OftpMessage
Get the ID associated with this message
getInstance(String, DataStore) - Static method in class com.adaptris.oftp.MessageStack
Return the instance of a message stack that corresponds to the remote ID.
getKeystorePassword() - Method in class com.adaptris.transport.SSLSocketTransport
Get the keystore password
getKeystoreUrl() - Method in class com.adaptris.transport.SSLSocketTransport
Get the keystore path.
getLength() - Method in class com.adaptris.oftp.CmdType
Get the length of the command.
getLength() - Method in class com.adaptris.oftp.OftpMessage
Get the length of the message
getListenPort() - Method in class com.adaptris.transport.TcpSocketTransport
Get the listen port.
getListenTimeout() - Method in class com.adaptris.oftp.OftpConfig
Get the Listen Timeout.
getLockFile() - Method in class com.adaptris.core.oftp.SimpleOftpDataStore
Get the lock file.
getMaxFileSize() - Method in class com.adaptris.core.oftp.OftpConnection
Get the maximum file size we will receive in 1k blocks.
getMaxFileSize() - Method in class com.adaptris.oftp.OftpConfig
Get the maximum file size
getMaxLockAttempts() - Method in class com.adaptris.core.oftp.SimpleOftpDataStore
Get the number of max lock attempts.
getMessageCount() - Method in class com.adaptris.oftp.MessageStack
Get the number of messages currently on the stack.
getMessageListener() - Method in class com.adaptris.oftp.OftpConfig
Get the listener handling inbound messages
getMessageType() - Method in class com.adaptris.oftp.OftpMessage
Get the message type that this object represents
getMode(char) - Static method in class com.adaptris.oftp.Mode
Get a MODE object from the specified String
getMode(String) - Static method in class com.adaptris.oftp.Mode
Get a MODE object from the specified String
getNextBlock() - Method in interface com.adaptris.oftp.DataBufferGenerator
Get the next block of data.
getNextMessage() - Method in class com.adaptris.oftp.MessageStack
Get the next message on the stack.
getNoConnectionFilter() - Method in class com.adaptris.core.transport.PppTcpClientConnection
Get the connection filter.
getNoConnectionFilter() - Method in class com.adaptris.transport.ppp.PppSocketTransport
Get the connection filter.
getOftpExceptionListener() - Method in class com.adaptris.core.oftp.ImmediateProducer
Get the OftpExceptionListener.
getOftpExceptionListener() - Method in class com.adaptris.core.oftp.OftpPollingConsumer
Get the OftpExceptionListener.
getOrigin() - Method in class com.adaptris.oftp.OftpMessage
Return the originator of this message
getPort() - Method in class com.adaptris.core.transport.TcpClientConnection
Get the port to connect to.
getPort() - Method in class com.adaptris.transport.TcpSocketTransport
Get the port to connect to
getPrivateKeyPassword() - Method in class com.adaptris.transport.SSLSocketTransport
Get the private key password
getProperties() - Method in class com.adaptris.oftp.OftpConfig
Get the properties that made this oftpConfig object
getReason() - Method in exception com.adaptris.oftp.OftpException
Return the reason for this exception
getRequireClientAuth() - Method in class com.adaptris.transport.SSLSocketTransport
Get the require client authentication flag.
getResponseListener() - Method in class com.adaptris.core.oftp.OftpPollingConsumer
Get the response listener.
getResponseListener() - Method in class com.adaptris.oftp.OftpConfig
Get the response listener
getSsidBufferCredit() - Method in class com.adaptris.core.oftp.OftpConnection
The number of buffers to send before expecting a credit.
getSsidBufferSize() - Method in class com.adaptris.core.oftp.OftpConnection
The buffer size for each data block.
getSsidCompression() - Method in class com.adaptris.core.oftp.OftpConnection
Get SSID flag indicating compression.
getSsidId() - Method in class com.adaptris.core.oftp.OftpConnection
Our SSID identity.
getSsidMode() - Method in class com.adaptris.core.oftp.NullConsumeConnection
 
getSsidMode() - Method in class com.adaptris.core.oftp.NullProduceConnection
 
getSsidMode() - Method in class com.adaptris.core.oftp.OftpConnection
Get the Mode of operation for this connection.
getSsidPassword() - Method in class com.adaptris.core.oftp.OftpConnection
Our SSID password.
getSsidReleaseLevel() - Method in class com.adaptris.core.oftp.OftpConnection
Get the SSID release level
getSsidRestart() - Method in class com.adaptris.core.oftp.OftpConnection
Get the SSId restart field.
getSsidSpecialLogic() - Method in class com.adaptris.core.oftp.OftpConnection
Get the special logic flag.
getSsidUserField() - Method in class com.adaptris.core.oftp.OftpConnection
The SSID userfield.
getTcpMode() - Method in class com.adaptris.core.oftp.OftpConnection
Get the compliancy mode.
getTimeoutMs() - Method in class com.adaptris.core.transport.TransportConfig
Get the timeout.
getTraceLogging() - Method in class com.adaptris.core.oftp.OftpConnection
Get the Trace Loggin flag.
getTransmissionBytes() - Method in interface com.adaptris.oftp.NSDU
Get the bytes associated with this NSDU.
getTransport() - Method in class com.adaptris.core.oftp.OftpConnection
The transport configuration.
getTransport() - Method in class com.adaptris.oftp.OftpClient
Get the transport to be used by this client.
getTransport() - Method in class com.adaptris.oftp.OftpServer
Get the transport that forms the connectivity for this server.
getUserField() - Method in class com.adaptris.oftp.OftpMessage
Get the user field associated with this OftpMessage
getUserManager() - Method in class com.adaptris.core.oftp.ImmediateProducer
Get the User Manager for this producer.
getUserManager() - Method in class com.adaptris.core.oftp.OftpPollingConsumer
Get the User Manager for this consumer.
getUserManager() - Method in class com.adaptris.oftp.OftpConfig
Get the user manager
getUsers() - Method in class com.adaptris.core.oftp.SimpleUserManager
Get all the configured users.

H

hashCode() - Method in class com.adaptris.oftp.OftpMessage
 
hasMoreBlocks() - Method in interface com.adaptris.oftp.DataBufferGenerator
Return true if there are more blocks.

I

ImmediateProducer - Class in com.adaptris.core.oftp
OFTP Producer implementation that produces immediately.
ImmediateProducer() - Constructor for class com.adaptris.core.oftp.ImmediateProducer
 
init() - Method in class com.adaptris.core.oftp.OftpPollingConsumer
 
init() - Method in class com.adaptris.core.oftp.OftpProducer
 
initConnection() - Method in class com.adaptris.core.oftp.OftpConnection
 
initFromProperties() - Method in class com.adaptris.transport.SSLSocketTransport
 
initFromProperties() - Method in class com.adaptris.transport.TcpSocketTransport
Perform initialisation from properties.
initialise(byte[], int) - Method in interface com.adaptris.oftp.DataBufferGenerator
Initialise the assembler
initialise(byte[]) - Method in interface com.adaptris.oftp.DataBufferGenerator
Initialise the assembler using the default configured block size.
initialise(byte[]) - Method in interface com.adaptris.oftp.NSDU
Convenience method to add bytes and initialise.
initialise() - Method in interface com.adaptris.oftp.NSDU
Parse the bytes and initialise the underlying data structure.
isEnabled(License) - Method in class com.adaptris.core.oftp.OftpConnection
 
isEnabled(License) - Method in class com.adaptris.core.oftp.OftpPollingConsumer
 
isEnabled(License) - Method in class com.adaptris.core.oftp.OftpProducer
 
isNull(String) - Method in class com.adaptris.core.oftp.OftpConnection
 
isTraceEnabled() - Method in class com.adaptris.oftp.OftpConfig
Get the extra debug flag.

L

listen(int) - Method in class com.adaptris.transport.ppp.PppSocketTransport
 
listen(int) - Method in class com.adaptris.transport.SSLSocketTransport
 
listen(int) - Method in class com.adaptris.transport.TcpSocketTransport
 
listen(int) - Method in class com.adaptris.transport.Transport
Listen for requests.
listProperties() - Method in class com.adaptris.transport.TcpSocketTransport
Get a list of the properties.
localInitialisation() - Method in class com.adaptris.core.oftp.NullConsumeConnection
 
localInitialisation() - Method in class com.adaptris.core.oftp.NullProduceConnection
 
localInitialisation() - Method in class com.adaptris.core.oftp.OftpConnection
Perform any local configuration that is required by the underlying connection type.
LoggingExceptionListener - Class in com.adaptris.core.oftp
Simple Oftp Exception Listener.
LoggingExceptionListener() - Constructor for class com.adaptris.core.oftp.LoggingExceptionListener
 
LoggingResponseListener - Class in com.adaptris.core.oftp
Simply log any received EERPS to any configured logger.
LoggingResponseListener() - Constructor for class com.adaptris.core.oftp.LoggingResponseListener
 
logR - Variable in class com.adaptris.core.transport.TransportConfig
 
logR - Variable in class com.adaptris.oftp.MessageStack
 
logR - Variable in class com.adaptris.transport.TcpSocketTransport
 

M

MESSAGE - Static variable in class com.adaptris.oftp.OftpMessage
A Normal Message
MessageListener - Interface in com.adaptris.oftp
Interface for handling data that is received during an OFTP session.
MessageStack - Class in com.adaptris.oftp
A Stack of OFTP Messages.
MessageStack() - Constructor for class com.adaptris.oftp.MessageStack
 
Mode - Class in com.adaptris.oftp
Defines the mode of operation for the SSID.

N

NSDU - Interface in com.adaptris.oftp
The common interface for all OFTP data blocks.
NullConsumeConnection - Class in com.adaptris.core.oftp
A consume connection for OFTP.
NullConsumeConnection() - Constructor for class com.adaptris.core.oftp.NullConsumeConnection
 
NullConsumeConnection(String, TransportConfig, OftpDataStore) - Constructor for class com.adaptris.core.oftp.NullConsumeConnection
 
NullProduceConnection - Class in com.adaptris.core.oftp
A dummy produce connection for OFTP.
NullProduceConnection() - Constructor for class com.adaptris.core.oftp.NullProduceConnection
 
NullProduceConnection(String, TransportConfig, OftpDataStore) - Constructor for class com.adaptris.core.oftp.NullProduceConnection
 

O

OftpClient - Class in com.adaptris.oftp
Entry point for an OFTP client Session.
OftpClient() - Constructor for class com.adaptris.oftp.OftpClient
 
OftpClient(Properties) - Constructor for class com.adaptris.oftp.OftpClient
Constructor using a set of Properties.
OftpClient(Properties, Transport) - Constructor for class com.adaptris.oftp.OftpClient
Constructor.
OftpConfig - Class in com.adaptris.oftp
Container for all the configuration required by an OftpSession.
OftpConfig() - Constructor for class com.adaptris.oftp.OftpConfig
Constructor
OftpConfig(Properties) - Constructor for class com.adaptris.oftp.OftpConfig
Constructor using a set of properties
OftpConnection - Class in com.adaptris.core.oftp
Contains configuration that is common to all OFTP Connection types.
OftpConnection() - Constructor for class com.adaptris.core.oftp.OftpConnection
Default Constructor ssidReleaseLevel = 1 ssidCompression = true ssidSpecialLogic = false ssidPassword = "" ssidBufferSize = 1024 ssidBufferCredit = 1 ssidUserField = "" maxFileSize = 9999999 ssidRestart = false tcpMode = true
OftpConstants - Class in com.adaptris.oftp
Constants
OftpDataStore - Class in com.adaptris.core.oftp
This class is the base abstract class for configuration an arbitary Datastore.
OftpDataStore() - Constructor for class com.adaptris.core.oftp.OftpDataStore
 
OftpException - Exception in com.adaptris.oftp
Container class detailing the exceptions that can occur during OFTP.
OftpException(Throwable, int) - Constructor for exception com.adaptris.oftp.OftpException
Constructor.
OftpException(String, int) - Constructor for exception com.adaptris.oftp.OftpException
Constructor.
OftpException(String, Throwable, int) - Constructor for exception com.adaptris.oftp.OftpException
Constructor.
OftpMessage - Class in com.adaptris.oftp
Container class for Messages being sent or received via OFTP.
OftpMessage() - Constructor for class com.adaptris.oftp.OftpMessage
 
OftpMessage(String, String) - Constructor for class com.adaptris.oftp.OftpMessage
Constructor
OftpMessage(byte[], String) - Constructor for class com.adaptris.oftp.OftpMessage
Constructor
OftpMessage(SFID) - Constructor for class com.adaptris.oftp.OftpMessage
Constructor
OftpMessage(EERP) - Constructor for class com.adaptris.oftp.OftpMessage
Constructor
OftpPollingConsumer - Class in com.adaptris.core.oftp
OFTP Polling Consumer.
OftpPollingConsumer() - Constructor for class com.adaptris.core.oftp.OftpPollingConsumer
 
OftpPollingConsumer(ConsumeDestination, UserManager) - Constructor for class com.adaptris.core.oftp.OftpPollingConsumer
 
OftpProducer - Class in com.adaptris.core.oftp
Abstract OFTP Producer implementation.
OftpProducer() - Constructor for class com.adaptris.core.oftp.OftpProducer
 
OftpServer - Class in com.adaptris.oftp
Entry point into an OFTP Server Session.
OftpServer(Properties) - Constructor for class com.adaptris.oftp.OftpServer
Constructor using a set of Properties.
OftpServer(Properties, Transport) - Constructor for class com.adaptris.oftp.OftpServer
Constructor.
OftpServer() - Constructor for class com.adaptris.oftp.OftpServer
 
onException(OftpMessage) - Method in class com.adaptris.core.oftp.LoggingExceptionListener
 
onException(OftpException) - Method in class com.adaptris.core.oftp.LoggingExceptionListener
 
onException(OftpMessage) - Method in interface com.adaptris.oftp.ExceptionListener
Called when an exception is encountered during the send of data.
onException(OftpException) - Method in interface com.adaptris.oftp.ExceptionListener
Called when an exception is encountered that cannot be associated with a message.
onMessage(OftpMessage) - Method in class com.adaptris.core.oftp.OftpPollingConsumer
 
onMessage(OftpMessage) - Method in interface com.adaptris.oftp.MessageListener
Handle the received data.
onResponse(OftpMessage) - Method in class com.adaptris.core.oftp.LoggingResponseListener
 
onResponse(OftpMessage) - Method in interface com.adaptris.oftp.ResponseListener
Handle the EERP.

P

PppSocketTransport - Class in com.adaptris.transport.ppp
This is a generic way of initiating a system command to dial up your ISP and initiate a socket connection.
PppSocketTransport() - Constructor for class com.adaptris.transport.ppp.PppSocketTransport
 
PppTcpClientConnection - Class in com.adaptris.core.transport
Class that acts as configuration for a client tcp connection over PPP.
PppTcpClientConnection() - Constructor for class com.adaptris.core.transport.PppTcpClientConnection
 
PppTcpClientConnection(String, int, String, String) - Constructor for class com.adaptris.core.transport.PppTcpClientConnection
 
prepare() - Method in class com.adaptris.core.oftp.OftpProducer
 
prepareConnection() - Method in class com.adaptris.core.oftp.OftpConnection
 
prepareConsumer() - Method in class com.adaptris.core.oftp.OftpPollingConsumer
 
printSocketInfo(Socket) - Method in class com.adaptris.transport.TcpSocketTransport
Print informatino about the socket.
processMessages() - Method in class com.adaptris.core.oftp.OftpPollingConsumer
 
produce(AdaptrisMessage, ProduceDestination) - Method in class com.adaptris.core.oftp.OftpProducer
 
produceMessage(OftpMessage, OftpClient, MessageStack) - Method in class com.adaptris.core.oftp.ImmediateProducer
 
produceMessage(OftpMessage, OftpClient, MessageStack) - Method in class com.adaptris.core.oftp.OftpProducer
Produce the message.
produceMessage(OftpMessage, OftpClient, MessageStack) - Method in class com.adaptris.core.oftp.QueuedProducer
 

Q

QueuedProducer - Class in com.adaptris.core.oftp
OFTP Producer implementation.
QueuedProducer() - Constructor for class com.adaptris.core.oftp.QueuedProducer
 

R

read() - Method in interface com.adaptris.transport.TransportLayer
Read a single byte.
ready() - Method in interface com.adaptris.oftp.NSDU
Query this NSDU to see if it is ready for initialisation.
RECEIVE - Static variable in class com.adaptris.oftp.Mode
Receive Only Mode
receive() - Method in interface com.adaptris.transport.TransportLayer
Receive some bytes.
remove(OftpMessage) - Method in class com.adaptris.oftp.MessageStack
Permanently remove a message from the queue.
ResponseListener - Interface in com.adaptris.oftp
Handle an End to End Responses that are sent by the remote server.
rewind(int) - Method in interface com.adaptris.transport.TransportLayer
Rewind the last read.
RTR - Static variable in class com.adaptris.oftp.CmdType
The RTR CmdType.
run() - Method in class com.adaptris.oftp.OftpClient
 
run() - Method in class com.adaptris.oftp.OftpServer
 

S

SEND - Static variable in class com.adaptris.oftp.Mode
Send Only Mode
send() - Method in class com.adaptris.oftp.OftpClient
Initiate a connection and send any existing files in the message stack.
send(byte[]) - Method in interface com.adaptris.transport.TransportLayer
Send some bytes.
send(byte[], int, int) - Method in interface com.adaptris.transport.TransportLayer
Send some bytes.
send(InputStream, int) - Method in interface com.adaptris.transport.TransportLayer
Send len bytes from in.
SEND_AND_RECEIVE - Static variable in class com.adaptris.oftp.Mode
Send and Receive Mode
serialVersionUID - Static variable in class com.adaptris.oftp.OftpMessage
the serial version UID for Serialization
serverSocket - Variable in class com.adaptris.transport.TcpSocketTransport
 
setAcceptedFormats(String) - Method in class com.adaptris.core.oftp.OftpConnection
set the configured Fileformat.
setAcceptedFormats(String) - Method in class com.adaptris.oftp.OftpConfig
Set the accepted file formats
setAlwaysTrust(boolean) - Method in class com.adaptris.transport.SSLSocketTransport
set the AlwaysTrust flag.
setBlockSize(int) - Method in class com.adaptris.core.transport.TransportConfig
Set the blocksize.
setBlockSize(int) - Method in class com.adaptris.transport.TcpSocketTransport
Set the blocksize for send and receive of data.
setBlockSize(int) - Method in interface com.adaptris.transport.TransportLayer
Set the max block size to read.
setBuffer(int, int) - Method in class com.adaptris.oftp.OftpConfig
Set the buffer size and credit amount
setCheckConnectionCommand(String) - Method in class com.adaptris.core.transport.PppTcpClientConnection
Set the command for checking a connection.
setCheckConnectionCommand(String) - Method in class com.adaptris.transport.ppp.PppSocketTransport
Set the command for checking a connection.
setCompression(boolean) - Method in class com.adaptris.oftp.OftpConfig
Support Compression
setConfiguration(Properties) - Method in class com.adaptris.transport.TcpSocketTransport
Set the configuration for this transport layer.
setConfiguration(Properties) - Method in class com.adaptris.transport.Transport
Set the configuration.
setConnectCommand(String) - Method in class com.adaptris.core.transport.PppTcpClientConnection
Set the connect command to use to dial.
setConnectCommand(String) - Method in class com.adaptris.transport.ppp.PppSocketTransport
Set the connect command to use to dial.
setConnectTimeout(int) - Method in class com.adaptris.transport.TcpSocketTransport
Set the connect timeout.
setData(byte[]) - Method in class com.adaptris.oftp.OftpMessage
Set the data contained in this message
setDataStore(OftpDataStore) - Method in class com.adaptris.core.oftp.OftpConnection
Set the configured datastore.
setDataStore(DataStore) - Method in class com.adaptris.oftp.OftpConfig
Set the underlying datastore used by the OFTP session.
setDate(Date) - Method in class com.adaptris.oftp.OftpMessage
Set the date for the SFID.
setDate(String, String) - Method in class com.adaptris.oftp.OftpMessage
Attempt to set the virtual date using two strings.
setDestination(String) - Method in class com.adaptris.oftp.OftpMessage
Set the destination of this message
setDisconnectCommand(String) - Method in class com.adaptris.core.transport.PppTcpClientConnection
Set the connect command to use to dial.
setDisconnectCommand(String) - Method in class com.adaptris.transport.ppp.PppSocketTransport
Set the connect command to use to dial.
setExceptionListener(ExceptionListener) - Method in class com.adaptris.oftp.OftpConfig
Set the listener for handling exceptions
setFileName(String) - Method in class com.adaptris.core.oftp.SimpleOftpDataStore
Set the filename to be use.
setHost(String) - Method in class com.adaptris.core.transport.TcpClientConnection
Set the host to connect to.
setHost(String) - Method in class com.adaptris.transport.TcpSocketTransport
Set the host to connect to.
setId(String) - Method in class com.adaptris.oftp.OftpMessage
Set the Id associated with this message
setInitiator(String, String) - Method in class com.adaptris.oftp.OftpConfig
Set our id for any connection attempt
setKeystorePassword(String) - Method in class com.adaptris.transport.SSLSocketTransport
Set the keystore password.
setKeystoreUrl(String) - Method in class com.adaptris.transport.SSLSocketTransport
Set the Keystore path
setListenPort(int) - Method in class com.adaptris.transport.TcpSocketTransport
Set the listen port.
setListenTimeout(int) - Method in class com.adaptris.oftp.OftpConfig
Set the Listen timeout.
setLockFile(String) - Method in class com.adaptris.core.oftp.SimpleOftpDataStore
Set the Lockfile to use.
setMaxFileSize(int) - Method in class com.adaptris.core.oftp.OftpConnection
Set the maximum file size we will receive in 1k blocks.
setMaxFileSize(int) - Method in class com.adaptris.oftp.OftpConfig
Set the maximum file size to be received
setMaxLockAttempts(int) - Method in class com.adaptris.core.oftp.SimpleOftpDataStore
Set the max lock attempts.
setMessageListener(MessageListener) - Method in class com.adaptris.oftp.OftpConfig
Set the listener for handling inbound messages
setMessageType(int) - Method in class com.adaptris.oftp.OftpMessage
Set the message type that this object represents
setMode(Mode) - Method in class com.adaptris.oftp.OftpConfig
Set the mode
setNoConnectionFilter(String) - Method in class com.adaptris.core.transport.PppTcpClientConnection
Set the filter for checkig there is no connection present.
setNoConnectionFilter(String) - Method in class com.adaptris.transport.ppp.PppSocketTransport
Set the filter for checkig there is no connection present.
setOftpExceptionListener(ExceptionListener) - Method in class com.adaptris.core.oftp.ImmediateProducer
Set the OftpExceptionListener.
setOftpExceptionListener(ExceptionListener) - Method in class com.adaptris.core.oftp.OftpPollingConsumer
Set the OftpExceptionListener.
setOrigin(String) - Method in class com.adaptris.oftp.OftpMessage
Get the originator of this message
setPort(int) - Method in class com.adaptris.core.transport.TcpClientConnection
Set the port to connect to.
setPort(int) - Method in class com.adaptris.transport.TcpSocketTransport
Set the port to connect to
setPrivateKeyPassword(String) - Method in class com.adaptris.transport.SSLSocketTransport
Set the private key password *
setProperties(Properties) - Method in class com.adaptris.oftp.OftpConfig
Set the properties for this OftpConfig object.
setReleaseLevel(int) - Method in class com.adaptris.oftp.OftpConfig
Set the protocol release level that we will use
setRequireClientAuth(boolean) - Method in class com.adaptris.transport.SSLSocketTransport
Set the require client authentication flag.
setResponseListener(ResponseListener) - Method in class com.adaptris.core.oftp.OftpPollingConsumer
Set the response Listener for this consumer.
setResponseListener(ResponseListener) - Method in class com.adaptris.oftp.OftpConfig
Set listener handling incoming EERPs
setRestart(boolean) - Method in class com.adaptris.oftp.OftpConfig
Support file restarts
setSpecialLogic(boolean) - Method in class com.adaptris.oftp.OftpConfig
Support Special Logic
setSsidBufferCredit(int) - Method in class com.adaptris.core.oftp.OftpConnection
The SSID buffer credit amount.
setSsidBufferSize(int) - Method in class com.adaptris.core.oftp.OftpConnection
The SSID buffer size.
setSsidCompression(boolean) - Method in class com.adaptris.core.oftp.OftpConnection
Set the compression flag.
setSsidId(String) - Method in class com.adaptris.core.oftp.OftpConnection
the SSID username.
setSsidMode(String) - Method in class com.adaptris.core.oftp.NullConsumeConnection
 
setSsidMode(String) - Method in class com.adaptris.core.oftp.NullProduceConnection
 
setSsidMode(String) - Method in class com.adaptris.core.oftp.OftpConnection
Set the mode of operation.
setSsidPassword(String) - Method in class com.adaptris.core.oftp.OftpConnection
The SSID password.
setSsidReleaseLevel(int) - Method in class com.adaptris.core.oftp.OftpConnection
Set the SSID release level.
setSsidRestart(boolean) - Method in class com.adaptris.core.oftp.OftpConnection
Set the SSID restart field.
setSsidSpecialLogic(boolean) - Method in class com.adaptris.core.oftp.OftpConnection
Set the special logic flag.
setSsidUserField(String) - Method in class com.adaptris.core.oftp.OftpConnection
The user defined field in an SSID.
setTcpMode(boolean) - Method in class com.adaptris.core.oftp.OftpConnection
Set the connection to be RFC2204 compliant.
setTimeout(int) - Method in interface com.adaptris.transport.TransportLayer
Set the Timeout to wait for data.
setTimeoutMs(int) - Method in class com.adaptris.core.transport.TransportConfig
Set the timeout.
setTraceLogging(boolean) - Method in class com.adaptris.core.oftp.OftpConnection
Enable or disable Trace Logging.
setTransport(TransportConfig) - Method in class com.adaptris.core.oftp.OftpConnection
The Transport type.
setTransport(Transport) - Method in class com.adaptris.oftp.OftpClient
Set the Transport to be used by this client.
setTransport(Transport) - Method in class com.adaptris.oftp.OftpServer
set the transport that forms the connectivity.
setUserField(String) - Method in class com.adaptris.oftp.OftpConfig
The user field within the SSID
setUserField(String) - Method in class com.adaptris.oftp.OftpMessage
Set the userfield associated with this OftpMessage
setUserManager(UserManager) - Method in class com.adaptris.core.oftp.ImmediateProducer
Set the usermanager for this producer.
setUserManager(UserManager) - Method in class com.adaptris.core.oftp.OftpPollingConsumer
Set the usermanager for this consumer.
setUserManager(UserManager) - Method in class com.adaptris.oftp.OftpConfig
Set the user manager
setUsers(KeyValuePairSet) - Method in class com.adaptris.core.oftp.SimpleUserManager
Set the users.
SFID - Static variable in class com.adaptris.oftp.CmdType
The SFID CmdType
SFNA - Static variable in class com.adaptris.oftp.CmdType
The SFNA CmdType.
SFNA_ACCESS_FAILURE - Static variable in exception com.adaptris.oftp.OftpException
SFNA Access method failure
SFNA_DUPLICATE_FILE - Static variable in exception com.adaptris.oftp.OftpException
SFNA Duplicate File
SFNA_INVALID_BYTE_COUNT - Static variable in exception com.adaptris.oftp.OftpException
SFNA Invalid Byte count
SFNA_INVALID_DESTINATION - Static variable in exception com.adaptris.oftp.OftpException
SFNA invalid destination
SFNA_INVALID_FILENAME - Static variable in exception com.adaptris.oftp.OftpException
SFNA invalid filename
SFNA_INVALID_ORIGIN - Static variable in exception com.adaptris.oftp.OftpException
SFNA invalid origin
SFNA_INVALID_RECORD - Static variable in exception com.adaptris.oftp.OftpException
SFNA maximum record length not support
SFNA_INVALID_RECORD_COUNT - Static variable in exception com.adaptris.oftp.OftpException
SFNA Invalid record count
SFNA_INVALID_STORAGE - Static variable in exception com.adaptris.oftp.OftpException
SFNA storage record format not supported
SFNA_TOO_BIG - Static variable in exception com.adaptris.oftp.OftpException
SFNA file size is too big
SFNA_UNSPECIFIED - Static variable in exception com.adaptris.oftp.OftpException
SFNA Unspecified reason
SFPA - Static variable in class com.adaptris.oftp.CmdType
The SFPA CmdType.
SimpleOftpDataStore - Class in com.adaptris.core.oftp
Wrapper around a datastore for use within the framework.
SimpleOftpDataStore() - Constructor for class com.adaptris.core.oftp.SimpleOftpDataStore
 
SimpleUserManager - Class in com.adaptris.core.oftp
Simple user manager based on configuration within the XML file only.
SimpleUserManager() - Constructor for class com.adaptris.core.oftp.SimpleUserManager
 
SimpleUserManager(KeyValuePairSet) - Constructor for class com.adaptris.core.oftp.SimpleUserManager
 
SocketConstants - Interface in com.adaptris.transport
Constants used in configuration.
socketLogger - Variable in class com.adaptris.transport.TcpSocketTransport
 
SSID - Static variable in class com.adaptris.oftp.CmdType
The SSID CmdType.
SSLSocketTransport - Class in com.adaptris.transport
Concrete implementation of Transport.
SSLSocketTransport() - Constructor for class com.adaptris.transport.SSLSocketTransport
 
SSRM - Static variable in class com.adaptris.oftp.CmdType
the SSRM CmdType.
start() - Method in class com.adaptris.core.oftp.OftpProducer
 
stop() - Method in class com.adaptris.core.oftp.OftpProducer
 
stop() - Method in class com.adaptris.oftp.OftpServer
Stop the listener.

T

TcpClientConnection - Class in com.adaptris.core.transport
Class that acts as configuration for a client tcp connection.
TcpClientConnection() - Constructor for class com.adaptris.core.transport.TcpClientConnection
 
TcpClientConnection(String, int) - Constructor for class com.adaptris.core.transport.TcpClientConnection
 
TcpSocketTransport - Class in com.adaptris.transport
Concrete implementation of Transport.
TcpSocketTransport() - Constructor for class com.adaptris.transport.TcpSocketTransport
 
toString() - Method in class com.adaptris.oftp.CmdType
 
toString() - Method in class com.adaptris.oftp.Mode
 
toString() - Method in class com.adaptris.oftp.OftpClient
 
toString() - Method in class com.adaptris.oftp.OftpConfig
 
toString() - Method in class com.adaptris.oftp.OftpMessage
 
toString() - Method in class com.adaptris.oftp.OftpServer
 
Transport - Class in com.adaptris.transport
The framework for handling the various types of transport.
Transport() - Constructor for class com.adaptris.transport.Transport
 
TransportConfig - Class in com.adaptris.core.transport
This class is the base abstract class for configuration an arbitary Transport.
TransportConfig() - Constructor for class com.adaptris.core.transport.TransportConfig
 
TransportConstants - Interface in com.adaptris.transport
Constants.
TransportException - Exception in com.adaptris.transport
The Transport Exception container.
TransportException(Throwable) - Constructor for exception com.adaptris.transport.TransportException
 
TransportException(String) - Constructor for exception com.adaptris.transport.TransportException
 
TransportException(String, Throwable) - Constructor for exception com.adaptris.transport.TransportException
 
TransportLayer - Interface in com.adaptris.transport
Interface specifying transport functionality.

U

UserManager - Interface in com.adaptris.oftp
Interface to handle users and passwords.
A B C D E G H I L M N O P Q R S T U 
Skip navigation links