com.devexperts.qd.qtp

Class ProtocolDescriptor

java.lang.Object

com.devexperts.qd.qtp.ProtocolDescriptor

public final class ProtocolDescriptor
extends Object

Descriptor for QTP protocol that is sent in DESCRIBE_PROTOCOL message.

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTHENTICATION_PROPERTY
static String	AUTHORIZATION_PROPERTY
static String	BASIC_AUTHORIZATION
static String	FILTER_PROPERTY
static String	MAGIC_STRING This string identifies protocol descriptor message.
static String	NAME_PROPERTY
static String	OPT_PROPERTY
static String	RMI_PROPERTY
static String	SERVICES_PROPERTY
static String	STRIPE_PROPERTY
static String	TIME_PROPERTY
static String	TYPE_PROPERTY
static String	VERSION_PROPERTY

Method Summary

Modifier and Type	Method and Description
void	addReceive(MessageDescriptor message)
void	addSend(MessageDescriptor message)
int	appendFromTextTokens(List<String> tokens, int i) Adds information to this protocol descriptor from a list of strings that are parsed from tab or comma separated text format.
boolean	canReceive(MessageType message)
boolean	canSend(MessageType message)
void	composeTo(com.devexperts.io.BufferedOutput out) Composes this protocol descriptor in compact binary format including its MAGIC_STRING.
List<String>	convertToTextTokens() Converts this protocol descriptor to a list of strings for representation in tab or comma separated text format.
com.devexperts.connector.proto.EndpointId	getEndpointId()
Map<String,String>	getProperties()
String	getProperty(String key)
MessageDescriptor	getReceive(MessageType message)
Set<MessageDescriptor>	getReceiveMessages()
EnumSet<MessageType>	getReceiveSet()
MessageDescriptor	getSend(MessageType message)
Set<MessageDescriptor>	getSendMessages()
EnumSet<MessageType>	getSendSet()
MessageDescriptor	newMessageDescriptor()
MessageDescriptor	newMessageDescriptor(MessageType messageType)
static ProtocolDescriptor	newPeerProtocolDescriptor(ProtocolDescriptor previouslyRead)
static ProtocolDescriptor	newPeerProtocolDescriptorReadAs(ProtocolDescriptor original, MessageType readAs)
static ProtocolDescriptor	newSelfProtocolDescriptor(String type) Creates empty protocol description for a specified type with an embedded QDS version.
void	parseFrom(com.devexperts.io.BufferedInput in) Parses protocol descriptor from compact binary format including its MAGIC_STRING.
void	setEndpointId(com.devexperts.connector.proto.EndpointId endpointId)
void	setProperty(String key, String value)
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAGIC_STRING

public static final String MAGIC_STRING

This string identifies protocol descriptor message.

See Also:

Constant Field Values

TYPE_PROPERTY

public static final String TYPE_PROPERTY

See Also:

Constant Field Values

VERSION_PROPERTY

public static final String VERSION_PROPERTY

See Also:

Constant Field Values

OPT_PROPERTY

public static final String OPT_PROPERTY

See Also:

Constant Field Values

TIME_PROPERTY

public static final String TIME_PROPERTY

See Also:

Constant Field Values

NAME_PROPERTY

public static final String NAME_PROPERTY

See Also:

Constant Field Values

FILTER_PROPERTY

public static final String FILTER_PROPERTY

See Also:

Constant Field Values

STRIPE_PROPERTY

public static final String STRIPE_PROPERTY

See Also:

Constant Field Values

SERVICES_PROPERTY

public static final String SERVICES_PROPERTY

See Also:

Constant Field Values

AUTHORIZATION_PROPERTY

public static final String AUTHORIZATION_PROPERTY

See Also:

Constant Field Values

AUTHENTICATION_PROPERTY

public static final String AUTHENTICATION_PROPERTY

See Also:

Constant Field Values

RMI_PROPERTY

public static final String RMI_PROPERTY

See Also:

Constant Field Values

BASIC_AUTHORIZATION

public static final String BASIC_AUTHORIZATION

See Also:

Constant Field Values

Method Detail

newSelfProtocolDescriptor

public static ProtocolDescriptor newSelfProtocolDescriptor(String type)

Creates empty protocol description for a specified type with an embedded QDS version. Types are used for files and should be short camel-case strings like "qtp" for socket QTP protocol, "tape" for generic tape files, "snapshot", "extract", etc.

Parameters:

type - the type.

Returns:

new protocol descriptor.

newPeerProtocolDescriptor

public static ProtocolDescriptor newPeerProtocolDescriptor(ProtocolDescriptor previouslyRead)

newPeerProtocolDescriptorReadAs

public static ProtocolDescriptor newPeerProtocolDescriptorReadAs(ProtocolDescriptor original,
                                                                 MessageType readAs)

newMessageDescriptor

public MessageDescriptor newMessageDescriptor()

newMessageDescriptor

public MessageDescriptor newMessageDescriptor(MessageType messageType)

getEndpointId

public com.devexperts.connector.proto.EndpointId getEndpointId()

setEndpointId

public void setEndpointId(com.devexperts.connector.proto.EndpointId endpointId)

getProperties

public Map<String,String> getProperties()

getSendMessages

public Set<MessageDescriptor> getSendMessages()

getReceiveMessages

public Set<MessageDescriptor> getReceiveMessages()

getProperty

public String getProperty(String key)

setProperty

public void setProperty(String key,
                        String value)

canSend

public boolean canSend(MessageType message)

canReceive

public boolean canReceive(MessageType message)

getSendSet

public EnumSet<MessageType> getSendSet()

getSend

public MessageDescriptor getSend(MessageType message)

getReceiveSet

public EnumSet<MessageType> getReceiveSet()

getReceive

public MessageDescriptor getReceive(MessageType message)

addSend

public void addSend(MessageDescriptor message)

addReceive

public void addReceive(MessageDescriptor message)

composeTo

public void composeTo(com.devexperts.io.BufferedOutput out)
               throws IOException

Composes this protocol descriptor in compact binary format including its MAGIC_STRING.

Throws:

IOException

parseFrom

public void parseFrom(com.devexperts.io.BufferedInput in)
               throws IOException

Parses protocol descriptor from compact binary format including its MAGIC_STRING.

Throws:

IOException - when descriptor cannot be read due to wrong magic or other reasons.

convertToTextTokens

public List<String> convertToTextTokens()

Converts this protocol descriptor to a list of strings for representation in tab or comma separated text format. It does not include its MAGIC_STRING.

appendFromTextTokens

public int appendFromTextTokens(List<String> tokens,
                                int i)

Adds information to this protocol descriptor from a list of strings that are parsed from tab or comma separated text format.

toString

public String toString()

Overrides:

toString in class Object