org.eclipse.scada.core.net

Class MessageHelper

java.lang.Object

org.eclipse.scada.core.net.MessageHelper

Direct Known Subclasses:

Messages

public class MessageHelper
extends Object

Field Summary

Fields

Modifier and Type	Field and Description
static int	CC_CLOSE_SESSION
static int	CC_CREATE_SESSION
static int	CC_PRIV_CHANGE
static int	CC_START_SESSION
static String	FIELD_OPERATION_PARAMETERS
static String	FIELD_PRIVS
static String	FIELD_SESSION_PROPERTIES
static String	FIELD_TRANSPORT_PROPERTIES
static String	FIELD_USER
static Object	PROP_USING_SESSION_START

Constructor Summary

Constructors

Constructor and Description
MessageHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static MapValue	attributesToMap(Map<String,org.eclipse.scada.core.Variant> attributes)
static Message	closeSession()
static OperationParameters	convertOperationParameters(Value value)
static Message	createPrivilegeChange(Set<String> privileges)
static Message	createSession(Properties props) Construct a CC_CREATE_SESSION message
static Message	createSessionACK(Message inputMessage, Map<String,String> sessionProperties, Map<String,String> transportProperties)
static void	encodeOperationParameters(OperationParameters operationParameters, Message message)
static Set<String>	getPrivileges(Message message)
static void	getProperties(Properties properties, Value value) Convert a map value to properties
static Map<String,org.eclipse.scada.core.Variant>	mapToAttributes(MapValue mapValue) Convert a MapValue to a attributes map
static org.eclipse.scada.core.Variant	valueToVariant(Value value, org.eclipse.scada.core.Variant defaultValue)
static Value	variantToValue(org.eclipse.scada.core.Variant value)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

CC_CREATE_SESSION

public static final int CC_CREATE_SESSION

See Also:

Constant Field Values

CC_CLOSE_SESSION

public static final int CC_CLOSE_SESSION

See Also:

Constant Field Values

CC_PRIV_CHANGE

public static final int CC_PRIV_CHANGE

See Also:

Constant Field Values

CC_START_SESSION

public static final int CC_START_SESSION

See Also:

Constant Field Values

FIELD_SESSION_PROPERTIES

public static final String FIELD_SESSION_PROPERTIES

See Also:

Constant Field Values

FIELD_TRANSPORT_PROPERTIES

public static final String FIELD_TRANSPORT_PROPERTIES

See Also:

Constant Field Values

FIELD_PRIVS

public static final String FIELD_PRIVS

See Also:

Constant Field Values

PROP_USING_SESSION_START

public static final Object PROP_USING_SESSION_START

FIELD_USER

public static final String FIELD_USER

See Also:

Constant Field Values

FIELD_OPERATION_PARAMETERS

public static final String FIELD_OPERATION_PARAMETERS

See Also:

Constant Field Values

Constructor Detail

MessageHelper

public MessageHelper()

Method Detail

mapToAttributes

public static Map<String,org.eclipse.scada.core.Variant> mapToAttributes(MapValue mapValue)

Convert a MapValue to a attributes map

Parameters:

mapValue - the map value to convert

Returns:

the attributes map

attributesToMap

public static MapValue attributesToMap(Map<String,org.eclipse.scada.core.Variant> attributes)

valueToVariant

public static org.eclipse.scada.core.Variant valueToVariant(Value value,
                                            org.eclipse.scada.core.Variant defaultValue)

variantToValue

public static Value variantToValue(org.eclipse.scada.core.Variant value)

createSession

public static Message createSession(Properties props)

Construct a CC_CREATE_SESSION message

Parameters:

props - the session properties

Returns:

the create session message

closeSession

public static Message closeSession()

getProperties

public static void getProperties(Properties properties,
                 Value value)

Convert a map value to properties

If the value is not a MapValue or is null the properties will not be modified.

Parameters:

properties - the properties to fill

value - the value to parse

createSessionACK

public static Message createSessionACK(Message inputMessage,
                       Map<String,String> sessionProperties,
                       Map<String,String> transportProperties)

createPrivilegeChange

public static Message createPrivilegeChange(Set<String> privileges)

getPrivileges

public static Set<String> getPrivileges(Message message)

Since:

1.1

convertOperationParameters

public static OperationParameters convertOperationParameters(Value value)

encodeOperationParameters

public static void encodeOperationParameters(OperationParameters operationParameters,
                             Message message)

Since:

1.1