SystemMessage (g9 jVine 2.9.0 API)

java.lang.Object
- no.g9.client.core.communication.SystemMessage

```
public final class SystemMessage
extends Object
```
Used to code/decode messages. This class is immutable

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACTIVE_INSTANCE_PORT` This port is used for setting the active dialog instance (for Close, Hide and Show actions).
`static SystemMessage`	`ACTIVE_INSTANCE_TEMPLATE` Send messages to this address for setting the active dialog instance.
`static String`	`ALERT_PORT` This port is used for displaying alert messages in the UA.
`static String`	`ALERT_RECEIVER` Send messages to this address for the alert port.
`static SystemMessage`	`ALERT_TEMPLATE` Send messages to this address for displaying alert messages in the UA.
`static String`	`ANY_RECEIVER` The system will forward the message to any system implementing this port.
`static String`	`CALLBACK_PORT` This port is used to handle call backs in dialog interactions.
`static SystemMessage`	`CALLBACK_TEMPLATE` Send messages to this address for call back in dialog interactions.
`static String`	`ERROR_PORT` This port is used to handle errors from the system.
`static String`	`MENU_PORT` Menu items use this port to execute the event of a message.
`static String`	`MESSAGE_ACTION_PERFORMER` The event method which performs actions received in messages.
`static String`	`OPEN_PORT` This port is used for opening a URL in a new tab or window.
`static String`	`OPEN_RECEIVER` Send messages to this address for the open port.
`static SystemMessage`	`OPEN_TEMPLATE` Send messages to this address opening a URL in a new tab or window.
`String`	`payload` The payload
`String`	`port` The port
`static String`	`QUERY_SETUP_PORT` Send messages to this address to query the URL of the system setup.
`static String`	`QUERY_SETUP_RECEIVER` Send messages to this address to query the URL of the system setup.
`static SystemMessage`	`QUERY_SETUP_TEMPLATE` Send messages to this address to query the URL of the system setup.
`String`	`receiver` The receiver
`static String`	`STACK_ELEVATE_PORT` Send messages to this address to elevate the application stack.
`static SystemMessage`	`STACK_ELEVATE_TEMPLATE` Send messages to this address to elevate the application stack.
`static String`	`STACK_POP_PORT` Send messages to this address to pop the application stack.
`static SystemMessage`	`STACK_POP_TEMPLATE` Send messages to this address to pop the application stack.
`static String`	`STACK_PUSH_PORT` Send messages to this address to push the application stack.
`static SystemMessage`	`STACK_PUSH_TEMPLATE` Send messages to this address to push the application stack.
`static String`	`STACK_RECEIVER` Send messages to this address to push or pop the application stack.
`static String`	`SYSTEM` The system address
`static String`	`URL_PORT` Send messages to this address to set the anchor part of the url to a message.
`static String`	`URL_RECEIVER` Send messages to this address to set the anchor part of the url to a message.
`static SystemMessage`	`URL_TEMPLATE` Send messages to this address to set the anchor part of the url to a message.

Constructor Summary

Constructors
Constructor and Description

SystemMessage(String codedMessage)
Constructor creating

SystemMessage(String receiver, String port, String payload)

Constructors
Constructor and Description
`SystemMessage(String codedMessage)` Constructor creating
`SystemMessage(String receiver, String port, String payload)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`code()` Codes this message
`SystemMessage`	`payload(String payload)` Creates a new message based on this but changes the payload
`SystemMessage`	`payload(SystemMessage payload)` Creates a new message based on this but changes the payload
`SystemMessage`	`port(String port)` Creates a new message based on this but changes the port
`SystemMessage`	`receiver(String receiver)` Creates a new message based on this but changes the receiver
`String`	`toString()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - ANY_RECEIVER
```
public static final String ANY_RECEIVER
```
    The system will forward the message to any system implementing this port.
    
    See Also:
    
    Constant Field Values
  - SYSTEM
```
public static final String SYSTEM
```
    The system address
    
    See Also:
    
    Constant Field Values
  - URL_RECEIVER
```
public static final String URL_RECEIVER
```
    Send messages to this address to set the anchor part of the url to a message.
    
    See Also:
    
    Constant Field Values
  - URL_PORT
```
public static final String URL_PORT
```
    Send messages to this address to set the anchor part of the url to a message.
    
    See Also:
    
    Constant Field Values
  - URL_TEMPLATE
```
public static final SystemMessage URL_TEMPLATE
```
    Send messages to this address to set the anchor part of the url to a message.
  - STACK_RECEIVER
```
public static final String STACK_RECEIVER
```
    Send messages to this address to push or pop the application stack.
    
    See Also:
    
    Constant Field Values
  - STACK_PUSH_PORT
```
public static final String STACK_PUSH_PORT
```
    Send messages to this address to push the application stack.
    
    See Also:
    
    Constant Field Values
  - STACK_ELEVATE_PORT
```
public static final String STACK_ELEVATE_PORT
```
    Send messages to this address to elevate the application stack.
    
    See Also:
    
    Constant Field Values
  - STACK_POP_PORT
```
public static final String STACK_POP_PORT
```
    Send messages to this address to pop the application stack.
    
    See Also:
    
    Constant Field Values
  - STACK_PUSH_TEMPLATE
```
public static final SystemMessage STACK_PUSH_TEMPLATE
```
    Send messages to this address to push the application stack.
  - STACK_ELEVATE_TEMPLATE
```
public static final SystemMessage STACK_ELEVATE_TEMPLATE
```
    Send messages to this address to elevate the application stack.
  - STACK_POP_TEMPLATE
```
public static final SystemMessage STACK_POP_TEMPLATE
```
    Send messages to this address to pop the application stack.
  - QUERY_SETUP_RECEIVER
```
public static final String QUERY_SETUP_RECEIVER
```
    Send messages to this address to query the URL of the system setup.
    
    See Also:
    
    Constant Field Values
  - QUERY_SETUP_PORT
```
public static final String QUERY_SETUP_PORT
```
    Send messages to this address to query the URL of the system setup.
    
    See Also:
    
    Constant Field Values
  - QUERY_SETUP_TEMPLATE
```
public static final SystemMessage QUERY_SETUP_TEMPLATE
```
    Send messages to this address to query the URL of the system setup.
  - MENU_PORT
```
public static final String MENU_PORT
```
    Menu items use this port to execute the event of a message.
    
    See Also:
    
    Constant Field Values
  - CALLBACK_PORT
```
public static final String CALLBACK_PORT
```
    This port is used to handle call backs in dialog interactions.
    
    See Also:
    
    Constant Field Values
  - CALLBACK_TEMPLATE
```
public static final SystemMessage CALLBACK_TEMPLATE
```
    Send messages to this address for call back in dialog interactions. Note: the application name must be added as a receiver.
  - ERROR_PORT
```
public static final String ERROR_PORT
```
    This port is used to handle errors from the system.
    
    See Also:
    
    Constant Field Values
  - ALERT_PORT
```
public static final String ALERT_PORT
```
    This port is used for displaying alert messages in the UA.
    
    See Also:
    
    Constant Field Values
  - ALERT_RECEIVER
```
public static final String ALERT_RECEIVER
```
    Send messages to this address for the alert port.
    
    See Also:
    
    Constant Field Values
  - ALERT_TEMPLATE
```
public static final SystemMessage ALERT_TEMPLATE
```
    Send messages to this address for displaying alert messages in the UA.
  - OPEN_PORT
```
public static final String OPEN_PORT
```
    This port is used for opening a URL in a new tab or window.
    
    See Also:
    
    Constant Field Values
  - OPEN_RECEIVER
```
public static final String OPEN_RECEIVER
```
    Send messages to this address for the open port.
    
    See Also:
    
    Constant Field Values
  - OPEN_TEMPLATE
```
public static final SystemMessage OPEN_TEMPLATE
```
    Send messages to this address opening a URL in a new tab or window.
  - ACTIVE_INSTANCE_PORT
```
public static final String ACTIVE_INSTANCE_PORT
```
    This port is used for setting the active dialog instance (for Close, Hide and Show actions).
    
    See Also:
    
    Constant Field Values
  - ACTIVE_INSTANCE_TEMPLATE
```
public static final SystemMessage ACTIVE_INSTANCE_TEMPLATE
```
    Send messages to this address for setting the active dialog instance.
  - MESSAGE_ACTION_PERFORMER
```
public static final String MESSAGE_ACTION_PERFORMER
```
    The event method which performs actions received in messages.
    
    See Also:
    
    Constant Field Values
  - receiver
```
public final String receiver
```
    The receiver
  - port
```
public final String port
```
    The port
  - payload
```
public final String payload
```
    The payload
- Constructor Detail
  - SystemMessage
```
public SystemMessage(String codedMessage)
```
    Constructor creating
    
    Parameters:
    
    codedMessage - The coded message
  - SystemMessage
```
public SystemMessage(String receiver,
                     String port,
                     String payload)
```
    Parameters:
    
    receiver - the receiver
    
    port - the port
    
    payload - the payload
- Method Detail
  - code
```
public String code()
```
    Codes this message
    
    Returns:
    
    The coded message
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - receiver
```
public SystemMessage receiver(String receiver)
```
    Creates a new message based on this but changes the receiver
    
    Parameters:
    
    receiver - the new receiver
    
    Returns:
    
    the new message
  - port
```
public SystemMessage port(String port)
```
    Creates a new message based on this but changes the port
    
    Parameters:
    
    port - the new port
    
    Returns:
    
    the new message
  - payload
```
public SystemMessage payload(String payload)
```
    Creates a new message based on this but changes the payload
    
    Parameters:
    
    payload - the new payload
    
    Returns:
    
    the new message
  - payload
```
public SystemMessage payload(SystemMessage payload)
```
    Creates a new message based on this but changes the payload
    
    Parameters:
    
    payload - the new payload
    
    Returns:
    
    the new message

Class SystemMessage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ANY_RECEIVER

SYSTEM

URL_RECEIVER

URL_PORT

URL_TEMPLATE

STACK_RECEIVER

STACK_PUSH_PORT

STACK_ELEVATE_PORT

STACK_POP_PORT

STACK_PUSH_TEMPLATE

STACK_ELEVATE_TEMPLATE

STACK_POP_TEMPLATE

QUERY_SETUP_RECEIVER

QUERY_SETUP_PORT

QUERY_SETUP_TEMPLATE

MENU_PORT

CALLBACK_PORT

CALLBACK_TEMPLATE

ERROR_PORT

ALERT_PORT

ALERT_RECEIVER

ALERT_TEMPLATE

OPEN_PORT

OPEN_RECEIVER

OPEN_TEMPLATE

ACTIVE_INSTANCE_PORT

ACTIVE_INSTANCE_TEMPLATE

MESSAGE_ACTION_PERFORMER

receiver

port

payload

Constructor Detail

SystemMessage

SystemMessage

Method Detail

code

toString

receiver

port

payload

payload