Index (Isode MHFCM API)

A B C D E F G I L M N O P Q R S T U V W
All Classes All Packages

A

ACP127 - com.isode.mhfcm.Component: An ACP127 channel process
ACP127Circuit - Class in com.isode.mhfcm: Object representing an ACP127Circuit.
ACP127Circuit.ACP127CircuitMode - Enum in com.isode.mhfcm
ACP127Circuit.ACP127CircuitType - Enum in com.isode.mhfcm: Enum used to distinguish different circuit types.
ACP127Circuit.S5066ARQMode - Enum in com.isode.mhfcm: Enum representing possible encoding types for the S5066 Server used by an ACP127Circuit.
ACP127Circuit.S5066EncodingType - Enum in com.isode.mhfcm: Enum representing possible encoding types for the S5066 Server used by an ACP127Circuit
ACP127Circuit.SerialEncodingType - Enum in com.isode.mhfcm: Enum representing possible encoding types for the serial line used by an ACP127Circuit
ACP127Circuit.TCPIPEncodingType - Enum in com.isode.mhfcm: Enum representing possible encoding types for a TCP/IP connection used by an ACP127Circuit
ACP142Channel - Class in com.isode.mhfcm: Represents information about a specific ACP142 channel.
addOTAMQualityEventHandler(OTAMQualityCallback) - Method in class com.isode.mhfcm.OTAMMonitor: Add a handler to be invoked when the quality of the signal meets or exceeds the trigger level.
AuthDetailsProvider - Interface in com.isode.mhfcm: This interface is used by a class which can provide AuthenticationDetails for a server connection in the event that the original BindProfile object did not contain any AuthenticationDetails
AuthenticationDetails - Class in com.isode.mhfcm: This class represents information used to authenticate to a server in the MHFCM environment.
AuthenticationDetails() - Constructor for class com.isode.mhfcm.AuthenticationDetails: Create an AuthenticationDetails object for anonymous authentication.
AuthenticationDetails(String, String) - Constructor for class com.isode.mhfcm.AuthenticationDetails: Create an AuthenticationDetails object for simple authentication, that is, authentication that uses a username/password without using SASL.
AuthenticationDetails(String, String, String) - Constructor for class com.isode.mhfcm.AuthenticationDetails: Create an AuthenticationDetails object for SIMPLE or SASL authentication

B

BindProfile - Class in com.isode.mhfcm: Class containing information required to make a connection to a particular server.
BindProfile(String, int, AuthenticationDetails) - Constructor for class com.isode.mhfcm.BindProfile: Construct a new BindProfile.
BROADCAST_RECEIVER - com.isode.mhfcm.ACP127Circuit.ACP127CircuitMode: A broadcast receiver circuit
BROADCAST_SENDER - com.isode.mhfcm.ACP127Circuit.ACP127CircuitMode: A broadcast sender circuit

C

Channel - Class in com.isode.mhfcm: Base class containing functionality common to all channels
CircuitStatus - Class in com.isode.mhfcm: Object used to represent circuit status.
CircuitStatus.Status - Enum in com.isode.mhfcm: Different types of CircuitStatus message.
close() - Method in class com.isode.mhfcm.MHFCMContext: Indicate that this context is no longer required.
code - Variable in enum com.isode.mhfcm.CircuitStatus.Status: A user-friendly representation of this message type
code - Variable in enum com.isode.mhfcm.OperatorMessage.MessageType
com.isode.mhfcm - package com.isode.mhfcm
component - Variable in exception com.isode.mhfcm.NoServerConnectionException
Component - Enum in com.isode.mhfcm: Enum used to represent the different types of service components available in the configuration
ConfigInconsistencyException - Exception in com.isode.mhfcm: Thrown when the API determines that information about the configuration that is held in the directory does not correspond with the live configuration.
ConfigInconsistencyException() - Constructor for exception com.isode.mhfcm.ConfigInconsistencyException
ConfigInconsistencyException(String) - Constructor for exception com.isode.mhfcm.ConfigInconsistencyException
ConfigInconsistencyException(String, Throwable) - Constructor for exception com.isode.mhfcm.ConfigInconsistencyException
ConfigInconsistencyException(String, Throwable, boolean, boolean) - Constructor for exception com.isode.mhfcm.ConfigInconsistencyException
ConfigInconsistencyException(Throwable) - Constructor for exception com.isode.mhfcm.ConfigInconsistencyException

D

DATA_BEING_RECEIVED - com.isode.mhfcm.CircuitStatus.Status: Data being received.
DATA_BEING_TRANSMITTED - com.isode.mhfcm.CircuitStatus.Status: Message received and waiting on operator action (submit/correct/discard).
DATA_NOT_BEING_RECEIVED - com.isode.mhfcm.CircuitStatus.Status: Data not being received.
date - Variable in class com.isode.mhfcm.OperatorMessage: The date that this message was sent.
description - Variable in enum com.isode.mhfcm.CircuitStatus.Status
description - Variable in enum com.isode.mhfcm.OperatorMessage.MessageType
DIGIPORT - com.isode.mhfcm.SerialLine.InterfaceType: Digiport TS Server (RFC 2217)
DIRECT_TO_MODEM - com.isode.mhfcm.Icon5066Server.Icon5066ServerMode
DIRECTORY_SERVER - com.isode.mhfcm.Component: A Directory Server
disconnect() - Method in class com.isode.mhfcm.OTAMMonitor: Disconnect this OTAM object from the OTAM server.
DSABindProfile - Class in com.isode.mhfcm: A BindProfile that contains information specific to Directory connections.
DSABindProfile(String, int, AuthenticationDetails, String) - Constructor for class com.isode.mhfcm.DSABindProfile: Construct a new BindProfile for a Directory server.

E

enableCircuit(boolean) - Method in class com.isode.mhfcm.ACP127Circuit: Enable or disable the circuit.
ERROR - com.isode.mhfcm.ServiceStatus.Severity: The component is running but reports a problem that requires attention
EVEN - com.isode.mhfcm.SerialLine.Parity: Even parity
ExternalS5066Server - Class in com.isode.mhfcm: A class representing an External S5066 server

F

FULL_8_BIT - com.isode.mhfcm.ACP127Circuit.S5066EncodingType: Full 8 bit

G

getACP127Circuits() - Method in class com.isode.mhfcm.MHFCMContext: Returns a list of configured ACP 127 Circuits in the configuration.
getACP127CircuitType() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the ACP127Circuit.ACP127CircuitType of this object.
getACP142Channels() - Method in class com.isode.mhfcm.MHFCMContext: Section 3.2.3 IRS-REQ-3: ACP 142 channels list.
getAuthenticationDetails(BindProfile, String, Component) - Method in interface com.isode.mhfcm.AuthDetailsProvider: This method is called when the MHFCM API needs the caller to supply authentication information for a server
getByteErrorRate() - Method in class com.isode.mhfcm.OTAMMonitor: Determine the current byte error rate for this OTAM.
getCircuitDescription() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the description of this ACP127 Circuit (the String used in any log messages)
getCircuitMode() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the circuit mode of this ACP127Circuit
getCircuitStatus() - Method in class com.isode.mhfcm.ACP127Circuit: Returns status for this circuit.
getCircuitType() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the circuit type (for example, "MRL", "ShipToShore", etc.)
getCountry() - Method in class com.isode.mhfcm.ACP127Circuit: Returns a String representing the country for this circuit (for example "NATO" or "NATIONAL").
getCTSRTS() - Method in class com.isode.mhfcm.SerialLine: Determine what CTS/RTS configuration is of this SerialLine
getDataWordSize() - Method in class com.isode.mhfcm.SerialLine: Determine the word size (in bits) of this serial line
getDefaultPriority() - Method in class com.isode.mhfcm.S5066AccessPoint: Determine the default priority for this access point.
getDescription() - Method in class com.isode.mhfcm.ACP142Channel: Determine the description of this ACP142Channel.
getDescription() - Method in class com.isode.mhfcm.ExternalS5066Server: Determine the description for this External 5066 server.
getDescription() - Method in class com.isode.mhfcm.S5066AccessPoint: Determine the description for this access point.
getDeviceName() - Method in class com.isode.mhfcm.SerialLine: Determine the name of the device associated with this SerialLine
getDomain() - Method in class com.isode.mhfcm.ExternalS5066Server: Determine the domain of this External S5066 server
getDomainAndPort() - Method in class com.isode.mhfcm.ExternalS5066Server: Get the domain and port for this External S5066 server.
getDomainName() - Method in class com.isode.mhfcm.SerialLine: Determine the domain name associated with this serial line
getDriverType() - Method in class com.isode.mhfcm.SerialLine: Determine the driver associated with this SerialLine
getExtraInfo() - Method in class com.isode.mhfcm.ServiceStatus: Returns a user-readable String with any supplementary information about the component's status.
getID() - Method in class com.isode.mhfcm.ACP127Circuit: Return an ID String which uniquely identifies this circuit, and no other circuit
getID() - Method in class com.isode.mhfcm.ACP142Channel: Return an ID String which uniquely identifies this channel, and no other channel.
getIntegerValue() - Method in enum com.isode.mhfcm.ACP127Circuit.ACP127CircuitMode: Determine the integer value corresponding to this mode (e.g.
getIntegerValue() - Method in enum com.isode.mhfcm.ACP127Circuit.ACP127CircuitType: Determine the integer value corresponding to this mode (e.g.
getIntegerValue() - Method in enum com.isode.mhfcm.Icon5066Server.Icon5066ServerMode: Determine the integer value corresponding to this mode (e.g.
getIsodeFullVersion() - Static method in class com.isode.mhfcm.MHFCMContext: Get a full Isode version string, e.g.
getIsodeShortVersion() - Static method in class com.isode.mhfcm.MHFCMContext: Get a short Isode version string, e.g.
getMsgConfigDN() - Method in class com.isode.mhfcm.DSABindProfile: Returns the DN of the messaging configuration
getMtaDN() - Method in class com.isode.mhfcm.DSABindProfile: Returns the DN containing the configuration for the MTA inside the directory
getName() - Method in class com.isode.mhfcm.ACP142Channel
getName() - Method in class com.isode.mhfcm.Channel: Determine the name of this channel
getName() - Method in class com.isode.mhfcm.ExternalS5066Server
getName() - Method in class com.isode.mhfcm.Icon5066Server
getName() - Method in class com.isode.mhfcm.S5066AccessPoint: Determine the server name of this access point.
getName() - Method in class com.isode.mhfcm.S5066Server: Determine the name of this S5066 server.
getName() - Method in class com.isode.mhfcm.SerialLine: Determine the name of this SerialLine
getName() - Method in enum com.isode.mhfcm.SerialLine.InterfaceType: Get the name of this driver
getOperatorMessages() - Method in class com.isode.mhfcm.ACP127Circuit: Return an ordered list of sent operator messages, with the most recent message as the first message in the list, and the oldest message as the last message in the list.
getOTAMErrorRate() - Method in class com.isode.mhfcm.ACP127Circuit: Get the currently-configured warning error percentage threshold
getOTAMMonitor() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the OTAMMonitor object associated with this circuit, if any (only used for BROADCAST_SENDER modes) (SERIAL only).
getOTAMSerialLine() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the serial line (attached to a modem) which the OTAM server is using to monitor this circuit (as configured in the Directory).
getParity() - Method in class com.isode.mhfcm.SerialLine: Determine the Parity for this serial line.
getPort() - Method in class com.isode.mhfcm.ExternalS5066Server: Determine the port number for this External S5066 server.
getPortNumber() - Method in class com.isode.mhfcm.SerialLine: Determine the port number associated with this serial line
getRank() - Method in class com.isode.mhfcm.S5066AccessPoint: Determine the rank for this access point.
getS5066AccessPoint() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the STANAG 5066 Access Point for this ACP127Circuit (S5066 only).
getS5066AccessPoints() - Method in class com.isode.mhfcm.MHFCMContext: Returns a list of configured ACP127 Access Points which provide access to S5066 servers.
getS5066ARQMode() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the ARQMode for this circuit (S5066 only).
getS5066EncodingType() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the encoding type for the S5066 server used by this ACP127Circuit (S5066 only).
getS5066Server() - Method in class com.isode.mhfcm.ACP142Channel: Determine the STANAG 5066 server for this ACP142Channel.
getS5066Server() - Method in class com.isode.mhfcm.S5066AccessPoint: Get the S5066Server object which the Access Point references
getS5066Servers() - Method in class com.isode.mhfcm.MHFCMContext: Returns a list of configured STANAG 5066 servers.
getSap() - Method in class com.isode.mhfcm.S5066AccessPoint: Determine the Sap for this access point.
getSAPID() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the STANAG S5066 SAP ID associated with this circuit (S5066 only).
getSAPID() - Method in class com.isode.mhfcm.ACP142Channel: Determine the STANAG 5066 SAP ID associated with this channel.
getSenderName() - Method in class com.isode.mhfcm.ACP127Circuit: Returns the name of the entity The entity that is sending data on the circuit (typically a ship sending data over a ship to shore circuit).
getSerialEncodingType() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the encoding type for the serial line used by this ACP127Circuit (SERIAL only).
getSerialLine() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the serial line being used by this circuit to transmit data (SERIAL only).
getSerialLine() - Method in class com.isode.mhfcm.Icon5066Server: Determine the serial line used by this Icon 5066 server.
getSerialSpeed() - Method in class com.isode.mhfcm.SerialLine: Determine the speed of this SerialLine
getServiceName() - Method in class com.isode.mhfcm.ServiceStatus: Returns a user-readable String identifying the component in question - this is useful when we are trying to distinguish between multiple components of the same type (e.g.
getServiceStatuses() - Method in class com.isode.mhfcm.MHFCMContext: Obtain the current service statuses of all components in the configuration.
getSeverity() - Method in class com.isode.mhfcm.ServiceStatus: Determine the severity of this ServiceStatus.
getStatus() - Method in class com.isode.mhfcm.CircuitStatus: Determine the status associated with this CircuitStatus
getStatus(String) - Static method in class com.isode.mhfcm.CircuitStatus: Determine the Status enum for a particular code string
getStopbits() - Method in class com.isode.mhfcm.SerialLine: Determine the number of stop bits for this serial line
getTCPHost() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the remote hostname for an ACP127Circuit of type (TCPIP only).
getTCPIPEncodingType() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the encoding type for the TCPIP connection used by this ACP127Circuit (TCPIP only).
getTCPPortNumber() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the remote port number for an ACP127Circuit of type (TCPIP only).
getTimeOfChange() - Method in class com.isode.mhfcm.CircuitStatus: Determine the time of the last state change.
getTransmitSpeed() - Method in class com.isode.mhfcm.ACP127Circuit: Determine the transmit speed of this ACP127Circuit (only applicable for asynchronous lines).
getTriggerLevel() - Method in class com.isode.mhfcm.OTAMMonitor: Determine the OTAM Trigger Level for this object.
getValueFor(int) - Static method in enum com.isode.mhfcm.ACP127Circuit.ACP127CircuitMode: Get the enum corresponding to a particular integer value
getValueFor(int) - Static method in enum com.isode.mhfcm.ACP127Circuit.ACP127CircuitType: Get the enum corresponding to a particular integer value
getValueFor(int) - Static method in enum com.isode.mhfcm.ACP127Circuit.S5066ARQMode: Get the enum corresponding to a particular int value
getValueFor(int) - Static method in enum com.isode.mhfcm.ACP127Circuit.S5066EncodingType: Get the enum corresponding to a particular int value
getValueFor(int) - Static method in enum com.isode.mhfcm.ACP127Circuit.SerialEncodingType: Get the enum corresponding to a particular int value
getValueFor(int) - Static method in enum com.isode.mhfcm.ACP127Circuit.TCPIPEncodingType: Get the enum corresponding to a particular int value

I

IA5 - com.isode.mhfcm.ACP127Circuit.S5066EncodingType: IA5
IA5 - com.isode.mhfcm.ACP127Circuit.SerialEncodingType: IA5 Full Character set
IA5 - com.isode.mhfcm.ACP127Circuit.TCPIPEncodingType: IA5 Full Character set
IA5_UC - com.isode.mhfcm.ACP127Circuit.S5066EncodingType: IA5 Upper Case only
IA5_UPPER - com.isode.mhfcm.ACP127Circuit.SerialEncodingType: IA5 Upper Case Only
IA5_UPPER - com.isode.mhfcm.ACP127Circuit.TCPIPEncodingType: IA5 Upper Case Only
Icon5066Server - Class in com.isode.mhfcm: Represents information about an Icon 5066 Server
Icon5066Server.Icon5066ServerMode - Enum in com.isode.mhfcm
IntegerOutOfRangeException - Exception in com.isode.mhfcm: Thrown when an out of range integer value is specified as an argument.
IntegerOutOfRangeException(String) - Constructor for exception com.isode.mhfcm.IntegerOutOfRangeException
InvalidOperationException - Exception in com.isode.mhfcm: Thrown when an attempt is made to perform an invalid operation.
InvalidOperationException() - Constructor for exception com.isode.mhfcm.InvalidOperationException
InvalidOperationException(String) - Constructor for exception com.isode.mhfcm.InvalidOperationException
InvalidOperationException(String, Throwable) - Constructor for exception com.isode.mhfcm.InvalidOperationException
InvalidOperationException(String, Throwable, boolean, boolean) - Constructor for exception com.isode.mhfcm.InvalidOperationException
InvalidOperationException(Throwable) - Constructor for exception com.isode.mhfcm.InvalidOperationException
isCircuitInUse() - Method in class com.isode.mhfcm.ACP127Circuit: Test whether this circuit is marked as being in-use or not-in-use
isEnabled() - Method in class com.isode.mhfcm.ACP127Circuit: Determine whether this circuit is enabled.
isEnabled() - Method in class com.isode.mhfcm.ACP142Channel: Determine whether this channel is enabled.
isMonitoring() - Method in class com.isode.mhfcm.OTAMMonitor: Return a boolean which indicates whether this OTAMMonitor is actually monitoring at the moment or not.
isOTAMEnabled() - Method in class com.isode.mhfcm.ACP127Circuit: Get current state of OTAM monitoring for this circuit
isSynchronous() - Method in class com.isode.mhfcm.SerialLine: Determine whether this SerialLine is synchronous or asynchronous
ITA2_5BIT - com.isode.mhfcm.ACP127Circuit.SerialEncodingType: ITA2 - 5 bit loose pack
ITA2_5BIT - com.isode.mhfcm.ACP127Circuit.TCPIPEncodingType: ITA2 - 5 bit loose pack
ITA2_DENSE - com.isode.mhfcm.ACP127Circuit.S5066EncodingType: ITA2 - Dense pack
ITA2_LOOSE - com.isode.mhfcm.ACP127Circuit.S5066EncodingType: ITA2 - Loose pack

L

last300Seconds - Variable in class com.isode.mhfcm.OTAMMonitor.ErrorRate: The error rate recorded during the last five minutes (300 seconds)
last60Seconds - Variable in class com.isode.mhfcm.OTAMMonitor.ErrorRate: The error rate recorded during the last minute (60 seconds)
last900Seconds - Variable in class com.isode.mhfcm.OTAMMonitor.ErrorRate: The error rate recorded during the last fifteen minutes (900 seconds)
LOCAL_DELIVERY - com.isode.mhfcm.ACP127Circuit.S5066ARQMode: Local delivery - actually means "it has been passed to the remote node to deliver"

M

MARK - com.isode.mhfcm.SerialLine.Parity: Mark parity
MESSAGE_RECEIVED_CORRECTLY - com.isode.mhfcm.OperatorMessage.MessageType: Message received correctly
messageType - Variable in class com.isode.mhfcm.OperatorMessage: The type of message, never null
MHFCMContext - Class in com.isode.mhfcm: This class represents an MHFCM configuration, and provides methods to retrieve information about all components of the configuration.
MHFCMContext(MHFCMContextParameters) - Constructor for class com.isode.mhfcm.MHFCMContext: Initialise a new context.
MHFCMContext(MHFCMContextParameters, AuthDetailsProvider) - Constructor for class com.isode.mhfcm.MHFCMContext: Initialise a new context, and provide an AuthDetailsProvider that can be used to ask the caller for authentication details when server connections are made
MHFCMContextParameters - Class in com.isode.mhfcm: A class which encapsulates a set of parameters to describe a specific MHFCM configuration
MHFCMContextParameters(BindProfile, DSABindProfile, BindProfile, BindProfile) - Constructor for class com.isode.mhfcm.MHFCMContextParameters: Create a new MHFCMContextParameters object, providing separate BindProfiles for each of the servers in the configuration.
MHFCMException - Exception in com.isode.mhfcm: Base class for all Exceptions thrown by this library
MHFCMException() - Constructor for exception com.isode.mhfcm.MHFCMException
MHFCMException(String) - Constructor for exception com.isode.mhfcm.MHFCMException
MHFCMException(String, Throwable) - Constructor for exception com.isode.mhfcm.MHFCMException
MHFCMException(String, Throwable, boolean, boolean) - Constructor for exception com.isode.mhfcm.MHFCMException
MHFCMException(Throwable) - Constructor for exception com.isode.mhfcm.MHFCMException
MORASKY - com.isode.mhfcm.SerialLine.InterfaceType: MoRaSky test driver

N

name - Variable in enum com.isode.mhfcm.ACP127Circuit.S5066ARQMode
name - Variable in enum com.isode.mhfcm.ACP127Circuit.S5066EncodingType
name - Variable in enum com.isode.mhfcm.ACP127Circuit.SerialEncodingType
name - Variable in enum com.isode.mhfcm.ACP127Circuit.TCPIPEncodingType
NATIVE - com.isode.mhfcm.ACP127Circuit.SerialEncodingType: Arbitrary
NATIVE - com.isode.mhfcm.ACP127Circuit.TCPIPEncodingType: Arbitrary
NO_CONNECTION - com.isode.mhfcm.ServiceStatus.Severity: No connection can be made to the component
NONE - com.isode.mhfcm.ACP127Circuit.S5066ARQMode: None
NONE - com.isode.mhfcm.SerialLine.Parity: No parity bits
NoServerConnectionException - Exception in com.isode.mhfcm: Thrown when an operation cannot be completed because there is no connection to the server.
NoServerConnectionException(Component) - Constructor for exception com.isode.mhfcm.NoServerConnectionException
NoServerConnectionException(Component, String) - Constructor for exception com.isode.mhfcm.NoServerConnectionException
NoServerConnectionException(Component, String, Throwable) - Constructor for exception com.isode.mhfcm.NoServerConnectionException
NoServerConnectionException(Component, String, Throwable, boolean, boolean) - Constructor for exception com.isode.mhfcm.NoServerConnectionException
NoServerConnectionException(Component, Throwable) - Constructor for exception com.isode.mhfcm.NoServerConnectionException
NotYetImplementedException - Exception in com.isode.mhfcm: This exception is thrown by methods in the API which are not yet implemented.
NotYetImplementedException() - Constructor for exception com.isode.mhfcm.NotYetImplementedException
NotYetImplementedException(String) - Constructor for exception com.isode.mhfcm.NotYetImplementedException
NotYetImplementedException(String, Throwable) - Constructor for exception com.isode.mhfcm.NotYetImplementedException
NotYetImplementedException(String, Throwable, boolean, boolean) - Constructor for exception com.isode.mhfcm.NotYetImplementedException
NotYetImplementedException(Throwable) - Constructor for exception com.isode.mhfcm.NotYetImplementedException

O

ODD - com.isode.mhfcm.SerialLine.Parity: Odd parity
OK - com.isode.mhfcm.ServiceStatus.Severity: Component exists and appears to be functioning correcly
ONE_WAY - com.isode.mhfcm.SerialLine.CTS_RTS_Setting: One way: TX flow control only.
OperatorMessage - Class in com.isode.mhfcm: A class representing an operator message that has been sent over FAB.
OperatorMessage(OperatorMessage.MessageType) - Constructor for class com.isode.mhfcm.OperatorMessage: Construct a new OperatorMessage object, with date "now"
OperatorMessage.MessageType - Enum in com.isode.mhfcm
OTAM - com.isode.mhfcm.Component: A OTAM server
OTAMMonitor - Class in com.isode.mhfcm: Represents an OTAM (Off the Air Management) monitoring instance.
OTAMMonitor(ACP127Circuit) - Constructor for class com.isode.mhfcm.OTAMMonitor: Construct a new OTAM instance
OTAMMonitor(MHFCMContext, DN) - Constructor for class com.isode.mhfcm.OTAMMonitor: Construct a new OTAM instance based on a channel definition.
OTAMMonitor.ErrorRate - Class in com.isode.mhfcm: An object containing error rate data from the OTAM.
OTAMQualityCallback - Interface in com.isode.mhfcm: Interface to be implemented by classes wishing to receive callbacks about OTAM circuit quality events.
OTHER - com.isode.mhfcm.ACP127Circuit.ACP127CircuitMode: Undefined circuit type
OTHER - com.isode.mhfcm.ACP127Circuit.ACP127CircuitType: Used for undefined circuits

P

parametersEvent(OTAMMonitor, int) - Method in interface com.isode.mhfcm.OTAMQualityCallback: Section 3.2.18 IRS-REQ-18: Quality OTAM Circuit Event.
POINT_TO_POINT - com.isode.mhfcm.ACP127Circuit.ACP127CircuitMode: A standard point-to-point circuit

Q

QUEUE_MANAGER - com.isode.mhfcm.Component: A Queue Manager

R

READY_TO_RECEIVE - com.isode.mhfcm.OperatorMessage.MessageType: Ready to receive another message
reconnect() - Method in class com.isode.mhfcm.OTAMMonitor: Connect or reconnect this OTAM object to the OTAM server
reconnectACP127() - Method in class com.isode.mhfcm.MHFCMContext: Close down any open ACP127 sessions and reconnect all known sessions.
reconnectDSA() - Method in class com.isode.mhfcm.MHFCMContext: Close down DSA connection if open and reconnect.
reconnectQueueManager() - Method in class com.isode.mhfcm.MHFCMContext: Close down Queue Manager connection if open and reconnect.
reloadConfiguration() - Method in class com.isode.mhfcm.MHFCMContext: Update the mt-serial attribute in the MTA's entry in the Directory, and then tell the Queue Manager to re-read its configuration from the Directory.
REMOTE_DELIVERY - com.isode.mhfcm.ACP127Circuit.S5066ARQMode: Remote delivery
removeOTAMQualityEventHandler(OTAMQualityCallback) - Method in class com.isode.mhfcm.OTAMMonitor: Remove a previously added OTAM quality callback.
REQUEST_FOR_RETRANSMISSION - com.isode.mhfcm.OperatorMessage.MessageType: Request for retransmission
reset() - Method in class com.isode.mhfcm.OTAMMonitor: Reset the calculated rate information for this OTAM.
RETURN_TO_IDLE - com.isode.mhfcm.OperatorMessage.MessageType: Return to idle (transmission is finished and circuit can be advertised as idle)
RTS_ALWAYS_OFF - com.isode.mhfcm.SerialLine.CTS_RTS_Setting: RTS and DTR off, no CTS handling.
RTS_ALWAYS_ON - com.isode.mhfcm.SerialLine.CTS_RTS_Setting: RTS and DTR locked on permanently.

S

S5066 - com.isode.mhfcm.ACP127Circuit.ACP127CircuitType: An S'5066 circuit
S5066_SERVER - com.isode.mhfcm.Component: An S'5066 Server
S5066AccessPoint - Class in com.isode.mhfcm: A class representing an an ACP127 circuit's access point to an S5066 Server
S5066Server - Class in com.isode.mhfcm: Abstract base class representing an S5066 Server
S5066Server() - Constructor for class com.isode.mhfcm.S5066Server
SERIAL - com.isode.mhfcm.ACP127Circuit.ACP127CircuitType: A serial line circuit
SerialLine - Class in com.isode.mhfcm: Represents a serial line.
SerialLine(SerialLine) - Constructor for class com.isode.mhfcm.SerialLine: Create a new Serial Line object by copying the values from an existing object into local variables.
SerialLine(SerialLine.InterfaceType) - Constructor for class com.isode.mhfcm.SerialLine: Create a new SerialLine object using data in the directory entry for an ACP127 circuit.
SerialLine.CTS_RTS_Setting - Enum in com.isode.mhfcm: Enum representing available CTS/RTS settings available on a SerialLine
SerialLine.InterfaceType - Enum in com.isode.mhfcm: Enum representing available interface (driver) types.
SerialLine.Parity - Enum in com.isode.mhfcm: Enum representing available parity values
SERIALPROXY - com.isode.mhfcm.SerialLine.InterfaceType: Serial Proxy
ServiceStatus - Class in com.isode.mhfcm: Class used to represent information about the status of a service component
ServiceStatus.Severity - Enum in com.isode.mhfcm: Enum representing the severity of a ServiceStatus.
setACP127CircuitType(ACP127Circuit.ACP127CircuitType) - Method in class com.isode.mhfcm.ACP127Circuit: Set the ACP127Circuit.ACP127CircuitType of this circuit.
setAddress(String, int) - Method in class com.isode.mhfcm.ExternalS5066Server: Set the domain and port of this External S5066 Server
setCircuitDescription(String) - Method in class com.isode.mhfcm.ACP127Circuit: Set the description for this circuit
setCircuitInUse(boolean) - Method in class com.isode.mhfcm.ACP127Circuit: Mark this circuit as being in-use or not-in-use.
setCTSRTS(SerialLine.CTS_RTS_Setting) - Method in class com.isode.mhfcm.SerialLine: Set the CTS/RTS mode of the Serial line.
setDataWordSize(int) - Method in class com.isode.mhfcm.SerialLine: Set this SerialLine's data word size
setDeviceName(String) - Method in class com.isode.mhfcm.SerialLine: Set the name of the device associated with this SerialLine
setDomainNameAndPort(String, int) - Method in class com.isode.mhfcm.SerialLine: Set the domain name and port to be associated with this serial line
setDriverType(SerialLine.InterfaceType) - Method in class com.isode.mhfcm.SerialLine: Set the driver type for this SerialLine
setDriverType(SerialLine.InterfaceType, String) - Method in class com.isode.mhfcm.SerialLine: Set the driver type for this SerialLine
setEnabled(boolean) - Method in class com.isode.mhfcm.ACP142Channel: Enable or disable the channel.
setName(String) - Method in class com.isode.mhfcm.SerialLine: Set this SerialLine's name
setOperatorMessage(OperatorMessage) - Method in class com.isode.mhfcm.ACP127Circuit: Configure an OperatorMessage for the circuit
setOTAMEnabled(boolean) - Method in class com.isode.mhfcm.ACP127Circuit: Enable or disable OTAM monitoring of this ACP127Circuit This will only take effect after MHFCMContext.reloadConfiguration() has been called.
setOTAMErrorRate(int) - Method in class com.isode.mhfcm.ACP127Circuit: Configure the error rate at which warnings will be logged by the OTAM process.
setOTAMSerialLine(SerialLine) - Method in class com.isode.mhfcm.ACP127Circuit: Configure the serial line (attached to a modem) which this OTAM is using to monitor this circuit.
setParity(SerialLine.Parity) - Method in class com.isode.mhfcm.SerialLine: Set this SerialLine's parity value
setS5066AccessPoint(S5066AccessPoint) - Method in class com.isode.mhfcm.ACP127Circuit: Specify a different STANAG 5066 Access Point to be used by this circuit (S5066 only).
setS5066ARQMode(ACP127Circuit.S5066ARQMode) - Method in class com.isode.mhfcm.ACP127Circuit: Set the ARQMode for this circuit (S5066 only).
setS5066EncodingType(ACP127Circuit.S5066EncodingType) - Method in class com.isode.mhfcm.ACP127Circuit: Set the encoding type for the S5066 server used by this ACP127Circuit (S5066 only).
setS5066Server(S5066Server) - Method in class com.isode.mhfcm.ACP142Channel: Specify a different STANAG 5066 server to be used by this circuit
setSAPID(int) - Method in class com.isode.mhfcm.ACP127Circuit: Set the STANAG S5066 SAP ID associated with this circuit (S5066 only).
setSerialEncodingType(ACP127Circuit.SerialEncodingType) - Method in class com.isode.mhfcm.ACP127Circuit: Set the encoding type for the serial line used by this ACP127Circuit (SERIAL only).
setSerialLine(SerialLine) - Method in class com.isode.mhfcm.ACP127Circuit: Specify the serial line to be used by this circuit to transmit data (SERIAL only).
setSerialLine(SerialLine) - Method in class com.isode.mhfcm.Icon5066Server: Change the serial line associated with this Icon S5066 server.
setSerialSpeed(int) - Method in class com.isode.mhfcm.SerialLine: Set the serial speed of an existing circuit
setStopBits(int) - Method in class com.isode.mhfcm.SerialLine: Set this SerialLine's number of stop bits
setSynchronous(Boolean) - Method in class com.isode.mhfcm.SerialLine: Set this SerialLine to be synchronous
setTCPHost(String) - Method in class com.isode.mhfcm.ACP127Circuit: Set the TCP hostname for the serial line used by this ACP127Circuit (TCPIP only).
setTCPIPEncodingType(ACP127Circuit.TCPIPEncodingType) - Method in class com.isode.mhfcm.ACP127Circuit: Set the encoding type for the TCPIP connection used by this ACP127Circuit (TCPIP only).
setTCPPortNumber(int) - Method in class com.isode.mhfcm.ACP127Circuit: Set the TCP port number for the serial line used by this ACP127Circuit (TCPIP only).
setTransmitSpeed(int) - Method in class com.isode.mhfcm.ACP127Circuit: Set the transmit speed of this ACP127Circuit (only applicable for asynchronous lines).
setTriggerLevel(int) - Method in class com.isode.mhfcm.OTAMMonitor: Set the OTAM Trigger Level for this object.
SPACE - com.isode.mhfcm.SerialLine.Parity: Space parity
STANAG5066 - com.isode.mhfcm.Icon5066Server.Icon5066ServerMode: Operate in S'5066 mode
startMonitoring() - Method in class com.isode.mhfcm.OTAMMonitor: Tell the OTAM server to start monitoring this circuit.
stopMonitoring() - Method in class com.isode.mhfcm.OTAMMonitor: Tell the OTAM server to stop monitoring this circuit.

T

TCPIP - com.isode.mhfcm.ACP127Circuit.ACP127CircuitType: A TCP/IP circuit
toString() - Method in class com.isode.mhfcm.ACP127Circuit: Returns a String representation of this object, suitable for debugging
toString() - Method in class com.isode.mhfcm.ACP142Channel: Returns a String representation of this object, suitable for debugging
toString() - Method in class com.isode.mhfcm.AuthenticationDetails
toString() - Method in class com.isode.mhfcm.BindProfile
toString() - Method in class com.isode.mhfcm.CircuitStatus
toString() - Method in class com.isode.mhfcm.DSABindProfile
toString() - Method in class com.isode.mhfcm.MHFCMContext
toString() - Method in class com.isode.mhfcm.MHFCMContextParameters
toString() - Method in class com.isode.mhfcm.SerialLine
TRANSMIT - com.isode.mhfcm.SerialLine.CTS_RTS_Setting: Transmit: RTS locked on while transmitting, wait for CTS to drop at end.
TWO_WAY - com.isode.mhfcm.SerialLine.CTS_RTS_Setting: Two way: use RTS as RTR for two-way flow control.

U

UNKNOWN - com.isode.mhfcm.OperatorMessage.MessageType: This should, of course, never happen
UNREADABLE - com.isode.mhfcm.OperatorMessage.MessageType: Unreadable (suggest try new frequency)
UNSET - com.isode.mhfcm.SerialLine.CTS_RTS_Setting: Unset: no flags specified - default behaviour of selected serial proxy driver will be used.

V

val - Variable in enum com.isode.mhfcm.ACP127Circuit.SerialEncodingType
val - Variable in enum com.isode.mhfcm.ACP127Circuit.TCPIPEncodingType
valueOf(String) - Static method in enum com.isode.mhfcm.ACP127Circuit.ACP127CircuitMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.isode.mhfcm.ACP127Circuit.ACP127CircuitType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.isode.mhfcm.ACP127Circuit.S5066ARQMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.isode.mhfcm.ACP127Circuit.S5066EncodingType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.isode.mhfcm.ACP127Circuit.SerialEncodingType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.isode.mhfcm.ACP127Circuit.TCPIPEncodingType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.isode.mhfcm.CircuitStatus.Status: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.isode.mhfcm.Component: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.isode.mhfcm.Icon5066Server.Icon5066ServerMode: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.isode.mhfcm.OperatorMessage.MessageType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.isode.mhfcm.SerialLine.CTS_RTS_Setting: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.isode.mhfcm.SerialLine.InterfaceType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.isode.mhfcm.SerialLine.Parity: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.isode.mhfcm.ServiceStatus.Severity: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.isode.mhfcm.ACP127Circuit.ACP127CircuitMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.isode.mhfcm.ACP127Circuit.ACP127CircuitType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.isode.mhfcm.ACP127Circuit.S5066ARQMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.isode.mhfcm.ACP127Circuit.S5066EncodingType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.isode.mhfcm.ACP127Circuit.SerialEncodingType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.isode.mhfcm.ACP127Circuit.TCPIPEncodingType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.isode.mhfcm.CircuitStatus.Status: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.isode.mhfcm.Component: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.isode.mhfcm.Icon5066Server.Icon5066ServerMode: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.isode.mhfcm.OperatorMessage.MessageType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.isode.mhfcm.SerialLine.CTS_RTS_Setting: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.isode.mhfcm.SerialLine.InterfaceType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.isode.mhfcm.SerialLine.Parity: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum com.isode.mhfcm.ServiceStatus.Severity: Returns an array containing the constants of this enum type, in the order they are declared.

W

WrongCircuitModeException - Exception in com.isode.mhfcm: Thrown when an operation on a circuit cannot be completed because the circuit is configured in the wrong mode (e.g.
WrongCircuitModeException(String) - Constructor for exception com.isode.mhfcm.WrongCircuitModeException

A B C D E F G I L M N O P Q R S T U V W
All Classes All Packages