A C D E G H I L N O R S T V

## A

AGENT_APPLICATION_ID - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Messages use the agent_application_id to identify the APAgent or APIA.
AGENT_CLIENT_ID - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Messages use the agent_client_id to identify the APAgent integration or APIA Integration Service.
APIA_PASSWORD - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  This token is used to specify the password that may be required when submitting APXML messages to the Integration Agent.
APIA_PRIORITY - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  This token is used to differentiate normal priority APXML messages from high priority APXML message.
APIA_PRIORITY_HIGH - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
APIA_PRIORITY_NORMAL - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
APIA_PROCESS_GROUP - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  This token is used to group APXML messages into subsets that are processed sequentially in FIFO order.
APIA_SOURCE - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  This token is used to indicate the source of an APXML message.
APIA_SOURCE_ALARMPOINT_PREFIX - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
APIA_SOURCE_APCLIENT_PREFIX - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
APIA_SOURCE_INTEGRATION_PREFIX - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
APXMLMessage - Interface in com.alarmpoint.integrationagent.apxml
  This interface provides access to the essential properties of an APXML message.
APXMLToken - Interface in com.alarmpoint.integrationagent.apxml
  The primary content of an APXML message is composed of tokens.
APXMLToken.Type - Enum in com.alarmpoint.integrationagent.apxml

## C

com.alarmpoint.integrationagent.apxml - package com.alarmpoint.integrationagent.apxml
com.alarmpoint.integrationagent.script.api - package com.alarmpoint.integrationagent.script.api
com.alarmpoint.integrationagent.security - package com.alarmpoint.integrationagent.security
com.alarmpoint.integrationagent.services - package com.alarmpoint.integrationagent.services
COMPANY_NAME - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Messages use the company_name token to specify the owning company.
createAPXML() - Method in interface com.alarmpoint.integrationagent.script.api.ServiceAPI
  Creates an new APXML message that the caller can populate.
createIntegrationServiceRequest() - Method in interface com.alarmpoint.integrationagent.script.api.ServiceAPI
  Creates an object that can be used to make an Integration Service Request to either a local (i.e., hosted on the same Integration Agent), or external Integration Service.

## D

decrypt(String) - Method in interface com.alarmpoint.integrationagent.script.api.ServiceAPI
  This method will decrypt the provided string.
DESTINATION - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  ExternalServiceRequest responses use destination to target the response.

## E

ERROR_CODE - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Error messages use the error_code to identify the problem cause.
ERROR_METHOD - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  The method/subclass for APXML sent by the server for failed submission.
ERROR_SUBCLASS - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage

## G

getAgentId() - Method in interface com.alarmpoint.integrationagent.services.GlobalService
  Gets the agent ID.
getConfiguration() - Method in interface com.alarmpoint.integrationagent.script.api.ServiceAPI
  Expose the service definition of this Integration Service.
getDomain() - Method in interface com.alarmpoint.integrationagent.services.GlobalService
  Gets the domain.
getKey() - Method in interface com.alarmpoint.integrationagent.apxml.APXMLToken
  Gets the token's key (i.e., name).
getLogger() - Method in interface com.alarmpoint.integrationagent.script.api.ServiceAPI
  Gets a logger that will write to the APIA log file in the same log4j category and format as the Integration Service.
getMethod() - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Gets the message's mandatory method, which defines the highest-level purpose of the message (e.g., Add, Delete, etc.).
getName() - Method in interface com.alarmpoint.integrationagent.services.GlobalService
  Gets service name.
getPassword() - Method in interface com.alarmpoint.integrationagent.services.GlobalService
  Gets the agent access password.
getSubclass() - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Gets the message's optional subclass, which provides a more refined purpose to the message (e.g., Add/Event).
getToken(String) - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Gets the token (if any) with the specified case-insensitive key.
getTokens() - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Gets the list of tokens that this message contains.
getTransactionId() - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Gets the mandatory transaction id, which is an application-defined value used track messages.
getType() - Method in interface com.alarmpoint.integrationagent.apxml.APXMLToken
  Get's the token's type.
getUrl() - Method in interface com.alarmpoint.integrationagent.services.GlobalService
  Gets URL.
getValue(String) - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Gets the value of the token (if any) with the specified case-insensitive key.
getValue() - Method in interface com.alarmpoint.integrationagent.apxml.APXMLToken
  Get's the token's value.
GlobalService - Interface in com.alarmpoint.integrationagent.services
  This interface expresses the global service.

## H

hasToken(String) - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Determines whether or not the message contains a token with the specified case-insensitive key.

## I

IntegrationServiceRequest - Interface in com.alarmpoint.integrationagent.script.api
  This is the interface through which the JavaScript implementation of an Integration Service can send an Integration Service Request to another Integration Service, regardless of whether the targeted Integration Service is local or remote.
isRequiredService(String, String) - Method in interface com.alarmpoint.integrationagent.services.GlobalService
  Check domain and service name match to this service or not.

## L

LIST_DELIM_SUFFIX - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Messages use a token with this suffix to indicate that its value represents a list delimiter for the corresponding unsuffixed token's value.

## N

NAME - Static variable in interface com.alarmpoint.integrationagent.script.api.ServiceAPI
  This is the name of the global variable in each Integration Service's script that is assigned an instance of this interface.

## O

OK_METHOD - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  The method/subclass for APXML sent by the server for successful submission.
OK_SUBCLASS - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
ORIGINATOR - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  ExternalServiceRequest messages use originator to indicate where the response should be targeted.

## R

RECIPIENTS - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Messages use the recipients token to specify who (e.g., user or group), should be contacted by whatever events/notifications the message initiates.
removeToken(String) - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Ensures that the message does not contain a token with the specified case-insensitive key.
REQUEST_ID - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  ExternalServiceRequet/Message messages use request_id to uniquely identify the message.
REQUEST_METHOD - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  The method/subclass for APXML sent by ExternalServiceRequest2.
REQUEST_SUBCLASS - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
RESPONSE_METHOD - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  The method/subclass for APXML sent to ExternalServiceRequest2.
RESPONSE_SUBCLASS - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage

## S

send() - Method in interface com.alarmpoint.integrationagent.script.api.IntegrationServiceRequest
  Sends the Integration Service Request to the targeted Integration Service.
SEND_METHOD - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  The method/subclass for APXML sent by ExternalServiceMessage.
SEND_SUBCLASS - Static variable in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
sendAPXML(APXMLMessage) - Method in interface com.alarmpoint.integrationagent.script.api.ServiceAPI
  Adds the specified APXML message to the end of the Integration Service's outbound queue.
sendAPXML(APXMLMessage, String, String) - Method in interface com.alarmpoint.integrationagent.script.api.ServiceAPI
  Adds the specified APXML message to the end of the specified service's inbound queue.
ServiceAPI - Interface in com.alarmpoint.integrationagent.script.api
  This interface represents the Integration Service functions that are exposed to an Integration Service's script.
setAction(String) - Method in interface com.alarmpoint.integrationagent.script.api.IntegrationServiceRequest
  Sets the (required) name of the Integration Service Request action that will be executed by the targeted Integration Service.
setAgentId(String) - Method in interface com.alarmpoint.integrationagent.script.api.IntegrationServiceRequest
  Sets the (optional) id of the Integration Agent to which the request will be sent, regardless of whether or not the Integration Agent provides the service specified by `IntegrationServiceRequest.setDomain(String)` and `IntegrationServiceRequest.setName(String)`.
setDomain(String) - Method in interface com.alarmpoint.integrationagent.script.api.IntegrationServiceRequest
  Sets the (required) Event Domain of the targeted Integration Service (e.g., "default").
setMethod(String) - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Sets the message's method.
setName(String) - Method in interface com.alarmpoint.integrationagent.script.api.IntegrationServiceRequest
  Sets the (required) name of the targeted Integration Service (e.g., "sample").
setSubclass(String) - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Sets the message's subclass.
setTimeout(long) - Method in interface com.alarmpoint.integrationagent.script.api.IntegrationServiceRequest
  Sets the (optional) timeout, in seconds, which determines how long the request will wait for a response from the targeted Integration Agent before generating an exception that is sent to the caller.
setToken(String, Object) - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Adds/replaces an auto-typed token to/in this message.
setToken(String, Object, APXMLToken.Type) - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  The analog of `APXMLMessage.setToken(String, Object)`, but with an explicit token type.
setToken(String, Object) - Method in interface com.alarmpoint.integrationagent.script.api.IntegrationServiceRequest
  Adds or replaces one of the parameters that will be passed to the targeted Integration Service's action.
setTransactionId(int) - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Sets the message's transaction id.
SymmetricCipherException - Exception in com.alarmpoint.integrationagent.security
  This exception is thrown when encryption or decryption processing fails.
SymmetricCipherException() - Constructor for exception com.alarmpoint.integrationagent.security.SymmetricCipherException
  Constructs an SymmetricCipherException with no detail message.
SymmetricCipherException(String, Throwable) - Constructor for exception com.alarmpoint.integrationagent.security.SymmetricCipherException
  Creates a SymmetricCipherException with the specified detail message and cause.
SymmetricCipherException(String) - Constructor for exception com.alarmpoint.integrationagent.security.SymmetricCipherException
  Constructs an SymmetricCipherException with the specified detail message.
SymmetricCipherException(Throwable) - Constructor for exception com.alarmpoint.integrationagent.security.SymmetricCipherException
  Creates a SymmetricCipherException with the specified cause

## T

toString() - Method in interface com.alarmpoint.integrationagent.apxml.APXMLMessage
  Gets the XML representation of this message.

## V

valueOf(String) - Static method in enum com.alarmpoint.integrationagent.apxml.APXMLToken.Type
  Returns the enum constant of this type with the specified name.
values() - Static method in enum com.alarmpoint.integrationagent.apxml.APXMLToken.Type
  Returns an array containing the constants of this enum type, in the order they are declared.

A C D E G H I L N O R S T V