com.highdeal.admin.hci
Interface InstanceInfo

All Superinterfaces:

java.lang.Comparable<InstanceInfo>, XMLMarshallable

All Known Implementing Classes:

InstanceInfoImpl

public interface InstanceInfo
extends XMLMarshallable, java.lang.Comparable<InstanceInfo>

This operation represents the interface of the instance info.

See Also:

for more info about XML description.

Field Summary

static java.lang.String

TAG_NAME The XML tag name of this class : "instanceInfo".

Method Summary

InstanceInfo	duplicate() Copies this InstanceInfo into a new instance of InstanceInfo
ServiceInfo.Address	getAddress(ServiceInfo.ServiceInfoType service) Gets the address defined for the service.
java.lang.String	getBatchServiceServerHost() Deprecated. since R4.1 use getHost(ServiceInfoType) instead
int	getBatchServiceServerPort() Deprecated. since R4.1 use getPort(ServiceInfoType) instead
java.lang.String	getFullHost(ServiceInfo.ServiceInfoType service) Gets the host name defined for the service with the multi-homing information.
java.lang.String	getHost(ServiceInfo.ServiceInfoType service) Gets the host name defined for the service.
java.lang.String	getHttpHost() Deprecated. since R4.1 use getHost(ServiceInfoType) instead
int	getHttpPort() Deprecated. since R4.1 use getPort(ServiceInfoType) instead
java.lang.String	getHTTPURL() Returns the HTTP URL.
InstanceId	getInstanceId() Returns the instance ID value.
java.lang.String	getInstanceName(boolean full) Returns the server instance (full)name. The full name has the following grammar: [<http host name>]<instanceId> The name is just the string representation of the InstanceId
java.lang.String	getMemorySize() Returns the max memory size used by the related JVM (-Xmx JVM param) .
java.lang.String	getMulticastHost() Deprecated. since R4.1 use getHost(ServiceInfoType) instead
int	getMulticastPort() Deprecated. since R4.1 use getPort(ServiceInfoType) instead
java.lang.String	getNotificationHost() Deprecated. since R4.1 use getHost(ServiceInfoType) instead
int	getNotificationPort() Deprecated. since R4.1 use getPort(ServiceInfoType) instead
java.lang.String	getOptions() Returns the extra options used by the related JVM.
int	getPort(ServiceInfo.ServiceInfoType service) Gets the port defined for the service.
ServiceInfo	getServiceInfo(ServiceInfo.ServiceInfoType serviceType) Returns the service information value, containing host value and port number.
java.lang.String	getSnmpHost() Deprecated. since R4.1 use getHost(ServiceInfoType) instead
int	getSnmpPort() Deprecated. since R4.1 use getPort(ServiceInfoType) instead
java.lang.String	getStatefulServiceServerHost() Deprecated. since R4.1 use getHost(ServiceInfoType) instead
int	getStatefulServiceServerPort() Deprecated. since R4.1 use getPort(ServiceInfoType) instead
java.lang.String	getStatelessServiceServerHost() Deprecated. since R4.1 use getHost(ServiceInfoType) instead
int	getStatelessServiceServerPort() Deprecated. since R4.1 use getPort(ServiceInfoType) instead
boolean	hasSame(InstanceId instanceId) Returns true if the instance info has the same instance id that the given parameter.
boolean	hasSame(InstanceType instanceType) Returns true if the instance info has the same instance type that the given parameter.
boolean	isBackup() Deprecated. since R4.1 use hasSame() with backup instead
boolean	isBatchServiceEnabled() Deprecated. since R4.1. Please use isServiceEnabled(ServiceInfo.ServiceInfoType) with BATCH instead.
boolean	isBillingAssistant() Deprecated. since R4.1 use hasSame() with billingAssistant instead
boolean	isCharger() Deprecated. since R4.1 use hasSame() with charger instead
boolean	isEZTaxer() Deprecated. since R4.1 use hasSame() with eztaxer instead
boolean	isGuider() Deprecated. since R4.1 use hasSame() with guider instead
boolean	isHttpMultipleBinding() Returns true if the HTTP server is bound to all available addresses.
boolean	isHTTPSecurityEnabled() Return true if the HTTP service security is enabled.
boolean	isPrimaryBackup() Deprecated. since R4.1 use hasSame() with PRIMARY_BACKUP_ID instead
boolean	isRater() Deprecated. since R4.1 use hasSame() with rater instead
boolean	isSecondaryBackup() Deprecated. since R4.1 use hasSame() with SECONDARY_BACKUP_ID instead
boolean	isServiceEnabled(ServiceInfo.ServiceInfoType serviceType) Returns true if the service is enabled.
boolean	isStatefulServiceEnabled() Deprecated. since R4.1 use isServiceEnabled(ServiceInfo.ServiceInfoType) with SFUL instead
boolean	isStatelessServiceEnabled() Deprecated. since R4.1 use isServiceEnabled(ServiceInfo.ServiceInfoType) with SLESS instead
boolean	isUpdater() Deprecated. since R4.1 use hasSame() with updater instead
void	isValid() Throws an InvalidInstanceInfoException if the instance info is malformed or invalid.
void	setFullHost(ServiceInfo.ServiceInfoType service, java.lang.String host) Sets the host name defined for the service with the multi-homing information.
void	setHost(ServiceInfo.ServiceInfoType service, java.lang.String host) Sets the host name defined for the service.
void	setHTTPSecurityEnable(boolean flag) Controls whether HTTP service secured or not.
void	setPort(ServiceInfo.ServiceInfoType service, int port) Sets the port defined for the service.

Methods inherited from interface com.highdeal.hci.XMLMarshallable

addCharacterData, addChild, marshal, setAttributes

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

TAG_NAME

static final java.lang.String TAG_NAME

The XML tag name of this class : "instanceInfo".

See Also:

Constant Field Values

Method Detail

getServiceInfo

ServiceInfo getServiceInfo(ServiceInfo.ServiceInfoType serviceType)

Returns the service information value, containing host value and port number.

Parameters:

serviceType - the service type, which is one among service info list.

Returns:

the service information.

getInstanceId

InstanceId getInstanceId()

Returns the instance ID value.

Returns:

the instance ID.

duplicate

InstanceInfo duplicate()

Copies this InstanceInfo into a new instance of InstanceInfo

Returns:

a new instance of InstanceInfo that is an exact copy of this instance

getAddress

ServiceInfo.Address getAddress(ServiceInfo.ServiceInfoType service)

Gets the address defined for the service.

Parameters:

service - value among service info list

Returns:

the address host name

getHost

java.lang.String getHost(ServiceInfo.ServiceInfoType service)

Gets the host name defined for the service.

Parameters:

service - value among service info list

Returns:

the service host name

getFullHost

java.lang.String getFullHost(ServiceInfo.ServiceInfoType service)

Gets the host name defined for the service with the multi-homing information.

Parameters:

service - value among service info list

Returns:

the service host name

getPort

int getPort(ServiceInfo.ServiceInfoType service)

Gets the port defined for the service.

Parameters:

service - value among service info list

Returns:

the service port

setFullHost

void setFullHost(ServiceInfo.ServiceInfoType service,
                 java.lang.String host)

Sets the host name defined for the service with the multi-homing information.

Parameters:

service - value among service info list

host - the new service host name

setHost

void setHost(ServiceInfo.ServiceInfoType service,
             java.lang.String host)

Sets the host name defined for the service.

Parameters:

service - value among service info list

host - the new service host name

setPort

void setPort(ServiceInfo.ServiceInfoType service,
             int port)

Sets the port defined for the service.

Parameters:

service - value among service info list

port - the new service port

getHttpHost

java.lang.String getHttpHost()

Deprecated. since R4.1 use getHost(ServiceInfoType) instead

Returns the bind address of the HCI service.

Returns:

the hostname.

getHttpPort

int getHttpPort()

Deprecated. since R4.1 use getPort(ServiceInfoType) instead

Returns the http port value.

Returns:

the http port number.

getStatelessServiceServerHost

java.lang.String getStatelessServiceServerHost()

Deprecated. since R4.1 use getHost(ServiceInfoType) instead

Returns the bind address of the stateless service server.

Returns:

the hostname.

getStatelessServiceServerPort

int getStatelessServiceServerPort()

Deprecated. since R4.1 use getPort(ServiceInfoType) instead

Returns the stateless service server port value.

Returns:

the stateless service server port number.

getStatefulServiceServerHost

java.lang.String getStatefulServiceServerHost()

Deprecated. since R4.1 use getHost(ServiceInfoType) instead

Returns the bind address of the stateful service server.

Returns:

the hostname.

getStatefulServiceServerPort

int getStatefulServiceServerPort()

Deprecated. since R4.1 use getPort(ServiceInfoType) instead

Returns the stateful service server port value.

Returns:

the stateful service server port number.

getBatchServiceServerHost

java.lang.String getBatchServiceServerHost()

Deprecated. since R4.1 use getHost(ServiceInfoType) instead

Returns the bind address of the stateful service server.

Returns:

the hostname.

getBatchServiceServerPort

int getBatchServiceServerPort()

Deprecated. since R4.1 use getPort(ServiceInfoType) instead

Returns the stateful service server port value.

Returns:

the stateful service server port number.

getMulticastHost

java.lang.String getMulticastHost()

Deprecated. since R4.1 use getHost(ServiceInfoType) instead

Returns the bind address of the multicast service server for the rating and guiding instances, the bind address of the multicast client for the updater.

Returns:

the hostname.

getMulticastPort

int getMulticastPort()

Deprecated. since R4.1 use getPort(ServiceInfoType) instead

Returns the multicast port value.

Returns:

the multicast port number.

getSnmpHost

java.lang.String getSnmpHost()

Deprecated. since R4.1 use getHost(ServiceInfoType) instead

Returns the bind address of the SNMP service server.

Returns:

the hostname.

getSnmpPort

int getSnmpPort()

Deprecated. since R4.1 use getPort(ServiceInfoType) instead

Returns the snmp port value.

Returns:

the snmp port number.

getNotificationHost

java.lang.String getNotificationHost()

Deprecated. since R4.1 use getHost(ServiceInfoType) instead

Returns the bind address of the notification service server.

Returns:

the hostname.

getNotificationPort

int getNotificationPort()

Deprecated. since R4.1 use getPort(ServiceInfoType) instead

Returns the notification service port.

Returns:

the notification service port number.

isHTTPSecurityEnabled

boolean isHTTPSecurityEnabled()

Return true if the HTTP service security is enabled.

Returns:

true indicates that HTTP service is secured; this is the default.

setHTTPSecurityEnable

void setHTTPSecurityEnable(boolean flag)

Controls whether HTTP service secured or not.

Parameters:

flag - set to true if the HTTP service security is enabled.

getHTTPURL

java.lang.String getHTTPURL()

Returns the HTTP URL.

Returns:

the HTTP URL.

getMemorySize

java.lang.String getMemorySize()

Returns the max memory size used by the related JVM (-Xmx JVM param) .

Returns:

the memory size.

getOptions

java.lang.String getOptions()

Returns the extra options used by the related JVM.

Returns:

the options.

hasSame

boolean hasSame(InstanceType instanceType)

Returns true if the instance info has the same instance type that the given parameter.

Parameters:

instanceType -

Returns:

true if the instance info has the same instance type that the given parameter.

hasSame

boolean hasSame(InstanceId instanceId)

Returns true if the instance info has the same instance id that the given parameter.

Parameters:

instanceId -

Returns:

true if the instance info has the same instance id that the given parameter.

isServiceEnabled

boolean isServiceEnabled(ServiceInfo.ServiceInfoType serviceType)

Returns true if the service is enabled.

Parameters:

serviceType -

Returns:

if the service is enabled.

isUpdater

boolean isUpdater()

Deprecated. since R4.1 use hasSame() with updater instead

Returns true if server is an updater instance.

Returns:

true if the instance info corresponding to an updater, false otherwise.

isRater

boolean isRater()

Deprecated. since R4.1 use hasSame() with rater instead

Returns true if server is an rater instance.

Returns:

true if the instance info corresponding to a rater, false otherwise.

isBackup

boolean isBackup()

Deprecated. since R4.1 use hasSame() with backup instead

Returns true if server is an backup instance.

Returns:

true if the instance info corresponding to a backup, false otherwise.

isGuider

boolean isGuider()

Deprecated. since R4.1 use hasSame() with guider instead

Returns true if server is a guider instance.

Returns:

true if the instance info corresponding to a guider, false otherwise.

isCharger

boolean isCharger()

Deprecated. since R4.1 use hasSame() with charger instead

Returns true if server is a charger instance.

Returns:

true if the instance info corresponding to a charger, false otherwise.

isEZTaxer

boolean isEZTaxer()

Deprecated. since R4.1 use hasSame() with eztaxer instead

Returns true if server is an eztaxer instance.

Returns:

true if the instance info corresponding to a eztaxer, false otherwise.

isPrimaryBackup

boolean isPrimaryBackup()

Deprecated. since R4.1 use hasSame() with PRIMARY_BACKUP_ID instead

Returns true if the server is the primary rater backup instance.

Returns:

true if the instance info corresponding to the primary backup, false otherwise.

isSecondaryBackup

boolean isSecondaryBackup()

Deprecated. since R4.1 use hasSame() with SECONDARY_BACKUP_ID instead

Returns true if the server is the secondary backup instance.

Returns:

true if the instance info corresponding to the secondary backup, false otherwise.

isBillingAssistant

boolean isBillingAssistant()

Deprecated. since R4.1 use hasSame() with billingAssistant instead

Returns true if the server is the billing assistant instance.

Returns:

true if the instance info corresponding to a billing assistant, false otherwise.

isStatefulServiceEnabled

boolean isStatefulServiceEnabled()

Deprecated. since R4.1 use isServiceEnabled(ServiceInfo.ServiceInfoType) with SFUL instead

Returns true if the stateful service is enabled.

Returns:

true if the stateful service type is enabled, false otherwise.

isStatelessServiceEnabled

boolean isStatelessServiceEnabled()

Deprecated. since R4.1 use isServiceEnabled(ServiceInfo.ServiceInfoType) with SLESS instead

Returns true if the stateless service is enabled.

Returns:

true if the stateless service type is enabled, false otherwise.

isBatchServiceEnabled

boolean isBatchServiceEnabled()

Deprecated. since R4.1. Please use isServiceEnabled(ServiceInfo.ServiceInfoType) with BATCH instead.

Returns true if the batch service is enabled.

Returns:

true if the batch service type is enabled, false otherwise.

getInstanceName

java.lang.String getInstanceName(boolean full)

Returns the server instance (full)name.
The full name has the following grammar:
[<http host name>]<instanceId>
The name is just the string representation of the InstanceId

Parameters:

full - true to return the full name, false to return the string representation of the instanceId.

Returns:

the (full)name of this instance.

isValid

void isValid()
             throws InvalidInstanceException

Throws an InvalidInstanceInfoException if the instance info is malformed or invalid.

Throws:

InvalidInstanceException - if the instance map is not valid.

isHttpMultipleBinding

boolean isHttpMultipleBinding()

Returns true if the HTTP server is bound to all available addresses.

Returns:

true if the HTTP server is bound to all available addresses.