org.adroitlogic.ultraesb.api.management

Class AddressDefinition

java.lang.Object

org.adroitlogic.ultraesb.api.management.AddressDefinition

public class AddressDefinition
extends Object

The address definition which can be added to endpoints to define addresses of an endpoint by the programmable API of the ESB

Since:

2.1.0

Author:

Ruwan

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AddressDefinition.Type Defined address types

Field Summary

Fields

Modifier and Type	Field and Description
static AddressDefinition	DEFAULT A default endpoint
static AddressDefinition	RESPONSE A response type endpoint

Constructor Summary

Constructors

Constructor and Description
AddressDefinition(String value) Constructs an address definition of type AddressDefinition.Type.URL with the given url
AddressDefinition(String id, AddressDefinition.Type type, String value) Constructs and address definition of the given type with the given identifier and value
AddressDefinition(String id, AddressDefinition.Type type, String value, double weight) Constructs and address definition of the given type with the given identifier and value for the given weight
AddressDefinition(String id, String value) Constructs an address definition of type AddressDefinition.Type.URL with the given url and identifier

Method Summary

Methods

Modifier and Type	Method and Description
String	getId() Gets the identifier of the address
AddressDefinition.Type	getType() Gets the type of the address
String	getValue() Gets the url or the url prefix of the address depending on the typ
double	getWeight() Gets the weight of the address

Methods inherited from class java.lang.Object

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

Field Detail

RESPONSE

public static final AddressDefinition RESPONSE

A response type endpoint

DEFAULT

public static final AddressDefinition DEFAULT

A default endpoint

Constructor Detail

AddressDefinition

public AddressDefinition(String value)

Constructs an address definition of type AddressDefinition.Type.URL with the given url

Parameters:

value - the url of the address

AddressDefinition

public AddressDefinition(String id,
                 String value)

Constructs an address definition of type AddressDefinition.Type.URL with the given url and identifier

Parameters:

id - the identifier of the address

value - the url of the address

AddressDefinition

public AddressDefinition(String id,
                 AddressDefinition.Type type,
                 String value)

Constructs and address definition of the given type with the given identifier and value

Parameters:

id - the identifier of the address

type - the type of the address

value - the value of the address, which is either a complete url or a url prefix

AddressDefinition

public AddressDefinition(String id,
                 AddressDefinition.Type type,
                 String value,
                 double weight)

Constructs and address definition of the given type with the given identifier and value for the given weight

Parameters:

id - the identifier of the address

type - the type of the address

value - the value of the address, which is either a complete url or a url prefix

weight - the weight of the address

Method Detail

getId

public String getId()

Gets the identifier of the address

Returns:

the identifier of the address

getWeight

public double getWeight()

Gets the weight of the address

Returns:

the weight of the address

getType

public AddressDefinition.Type getType()

Gets the type of the address

Returns:

the type of the address

getValue

public String getValue()

Gets the url or the url prefix of the address depending on the typ

Returns:

the url or the url prefix value of the address