Module: Siffer::Messages

Defined in:

lib/siffer/messages/ack.rb,
lib/siffer/messages/error.rb,
lib/siffer/messages/event.rb,
lib/siffer/messages/header.rb,
lib/siffer/messages/status.rb,
lib/siffer/messages/message.rb,
lib/siffer/messages/provide.rb,
lib/siffer/messages/request.rb,
lib/siffer/messages/register.rb,
lib/siffer/messages/response.rb,
lib/siffer/messages/provision.rb,
lib/siffer/messages/subscribe.rb,
lib/siffer/messages/system_control.rb

Defined Under Namespace

Classes: Ack, Application, CancelRequests, ColumnHeaders, Condition, ConditionGroup, Conditions, Contexts, Element, Error, Event, EventObject, ExtendedQuery, ExtendedQueryResults, From, GetAgentACL, GetMessage, GetZoneStatus, Header, JoinOn, LeftElement, Message, Object, OrderBy, Ping, Property, Protocol, Provide, Provision, Query, QueryObject, R, Register, Request, RequestMsgIds, Response, RightElement, Rows, SecureChannel, Security, Select, Sleep, Status, Subscribe, SystemControl, UnProvide, Unregister, Unsubscribe, Wakeup, Where

Constant Summary

ERROR_CATEGORY =

{
  0	 => "Unknown (This should NEVER be used if possible)",
  1	 => "XML Validation",
  2	 => "Encryption",
  3	 => "Authentication",
  4	 => "Access and Permissions",
  5	 => "Registration",
  6	 => "Provision",
  7	 => "Subscription",
  8	 => "Request and Response",
  9	 => "Event Reporting and Processing",
  10 => "Transport",
  11 => "System (OS, Database, Vendor localized, etc.)",
  12 => "Generic Message Handling",
  13 => "SMB Handling"
}

XML_VALIDATION_ERROR =

{
  1	=> "Generic error",
  2	=> "Message is not well-formed",
  3	=> "Generic validation error",
  4	=> "Invalid value for element/attribute",
  6	=> "Missing mandatory element/attribute"
}

ENCRYPTION_ERROR =

{ 1 => "Generic Error" }

AUTHENTICATION_ERROR =

{
  1	 => "Generic error",
  2	 => "Generic authentication error (with signature)",
  3	 => "Missing sender's certificate",
  4	 => "Invalid certificate",
  5	 => "Sender's certificate is not trusted",
  6	 => "Expired certificate",
  7	 => "Invalid signature",
  8	 => "Invalid encryption algorithm (only accepts MD4)",
  9	 => "Missing public key of the receiver (when decrypting message)",
  10 => "Missing receiver's private key (when decrypting message)"
}

ACCESS_AND_PERMISSION_ERROR =

{
  1	 => "Generic error",
  2	 => "No permission to register",
  3	 => "No permission to provide this object",
  4	 => "No permission to subscribe to this SIF_Event",
  5	 => "No permission to request this object",
  6	 => "No permission to respond to this object request",
  7	 => "No permission to publish SIF_Event",
  8	 => "No permission to administer policies",
  9	 => "SIF_SourceId is not registered",
  10 => "No permission to publish SIF_Event Add",
  11 => "No permission to publish SIF_Event Change",
  12 => "No permission to publish SIF_Event Delete"
}

REGISTRATION_ERROR =

{
  1	 => "Generic error",
  2	 => "The SIF_SourceId is invalid",
  3	 => "Requested transport protocol is unsupported",
  4	 => "Requested SIF_Version(s) not supported.",
  6	 => "Requested SIF_MaxBufferSize is too small",
  7	 => "ZIS requires a secure transport",
  9	 => "Agent is registered for push mode (returned when a push-mode agent sends a SIF_GetMessage).",
  10 => "ZIS does not support the requested Accept-Encoding value."
}

PROVISION_ERROR =

{
  1	=> "Generic error",
  3	=> "Invalid object",
  4	=> "Object already has a provider (SIF_Provide message)"
}

SUBSCRIPTION_ERROR =

{
  1 => "Generic error",
  3 => "Invalid object"
}

REQUEST_AND_RESPONSE_ERROR =

{
  1	 => "Generic error",
  3	 => "Invalid object",
  4	 => "No provider",
  7	 => "Responder does not support requested SIF_Version",
  8	 => "Responder does not support requested SIF_MaxBufferSize",
  9	 => "Unsupported query in request",
  10 => "Invalid SIF_RequestMsgId specified in SIF_Response",
  11 => "SIF_Response is larger than requested SIF_MaxBufferSize",
  12 => "SIF_PacketNumber is invalid in SIF_Response",
  13 => "SIF_Response does not match any SIF_Version from SIF_Request",
  14 => "SIF_DestinationId does not match SIF_SourceId from SIF_Request",
  15 => "No support for SIF_ExtendedQuery",
  16 => "SIF_RequestMsgId deleted from cache due to timeout",
  17 => "SIF_RequestMsgId deleted from cache by administrator",
  18 => "SIF_Request cancelled by requesting agent"
}

EVENT_REPORTING_AND_PROCESSING_ERROR =

{
  1 => "Generic error",
  3 => "Invalid event"
}

TRANSPORT_ERROR =

{
  1	=> "Generic error",
  2	=> "Requested protocol is not supported",
  3	=> "Secure channel requested and no secure path exists",
  4	=> "Unable to establish connection"
}

SYSTEM_ERROR =

{ 1 => "Generic error" }

GENERIC_MESSAGE_HANDLING_ERROR =

{
  1	=> "Generic error",
  2	=> "Message not supported",
  3	=> "Version not supported",
  4	=> "Context not supported",
  5	=> "Protocol error",
  6	=> "No such message (as identified by SIF_OriginalMsgId)",
  7	=> "Multiple contexts not supported"
}

SMB_ERROR =

{
  1	=> "Generic error",
  2	=> "SMB can only be invoked during a SIF_Event acknowledgement",
  3	=> "Final SIF_Ack expected from Push-Mode Agent",
  4	=> "Incorrect SIF_MsgId in final SIF_Ack"
}

ERROR_CODES =

{
1 => XML_VALIDATION_ERROR, 
2 => ENCRYPTION_ERROR, 
3 => AUTHENTICATION_ERROR, 
4 => ACCESS_AND_PERMISSION_ERROR,
5 => REGISTRATION_ERROR,
6 => PROVISION_ERROR,
7 => SUBSCRIPTION_ERROR,
8 => REQUEST_AND_RESPONSE_ERROR,
9 => EVENT_REPORTING_AND_PROCESSING_ERROR,
10 => TRANSPORT_ERROR,
11 => SYSTEM_ERROR,
12 => GENERIC_MESSAGE_HANDLING_ERROR,
13 => SMB_ERROR}

STATUS_CODE =

{
  0	=> "Success (ZIS ONLY). SIF_Status/SIF_Data may contain additional data.",
  1	=> "Immediate SIF_Ack (AGENT ONLY). Message is persisted or processing is complete. Discard the referenced message.",
  2	=> "Intermediate SIF_Ack (AGENT ONLY). Only valid in response to SIF_Event delivery. Invokes Selective Message Blocking. The event referenced must still be persisted, and no other events must be delivered, until the agent sends a \"Final\" SIF_Ack at a later time.",
  3	=> "Final SIF_Ack (AGENT ONLY). Sent (a SIF_Ack with this value is never returned by an agent in response to a delivered message) by an agent to the ZIS to end Selective Message Blocking. Discard the referenced event and allow for delivery of other events.",
  7	=> "Already have a message with this SIF_MsgId from you.",
  8	=> "Receiver is sleeping.",
  9	=> "No messages available. This is returned when an agent is trying to pull messages from a ZIS and there are no messages available."
}

CONDITION_GROUP_TYPES =

{
  :and => "And",
  :or => "Or",
  :none => "None"
}

OPERATORS =

{
  :equals => "EQ",
  :less_than => "LT",
  :greater_than => "GT",
  :less_than_or_equals => "LE",
  :greater_than_or_equals => "GE",
  :not_equals => "NE"
}

ORDERING =

{
  :asc => "Ascending",
  :des => "Descending"
}

DEFINED_PROTOCOLS_TYPE =

Used by Protocol to describe the protocol used by the agent

{
  :http => "HTTP",
  :https => "HTTPS"
}

MORE_PACKETS =

{
  :yes => "Yes",
  :no => "No"
}

NOTIFICATION_TYPES =

{
  :standard => "Standard",
  :none => "None"
}