Package org.jolokia.server.core.service.api

Class AgentDetails

java.lang.Object

org.jolokia.server.core.service.api.AgentDetails

public class AgentDetails
extends Object

Agent details describing this agent. This information during discovery of the agent. This object is mutable so that since the information is possible collected peu-a-peu through various channels.

Since:

31.01.14

Author:

roland

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	AgentDetails.AgentDetailProperty	Enum holding the possible values for the discovery request/response.

Constructor Summary

Constructors

Constructor	Description
AgentDetails(String pAgentId)
AgentDetails(Map<AgentDetails.AgentDetailProperty,Object> pMsgData)	Constructor used when the input has been parsed
AgentDetails(Configuration pConfig, ServerHandle pServerHandle)

Method Summary

Modifier and Type	Method	Description
String	getAgentId()	Get the ID specific for these agent
boolean	isInitRequired()	Check if either url or security information is missing.
boolean	isSecuredMissing()
boolean	isUrlMissing()
void	seal()	Seal this details so that no further updates are possible
void	setSecured(Boolean pSecured)
void	setUrl(String url)
org.json.simple.JSONObject	toJSONObject()	Get the details as JSON Object
String	toString()
void	updateAgentParameters(String pUrl, Boolean pSecured)	Update agent connection data

Methods inherited from class java.lang.Object

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

Constructor Details

AgentDetails

public AgentDetails(String pAgentId)

AgentDetails

public AgentDetails(Configuration pConfig,
 ServerHandle pServerHandle)

AgentDetails

public AgentDetails(Map<AgentDetails.AgentDetailProperty,Object> pMsgData)

Constructor used when the input has been parsed

Parameters:

pMsgData - data send via multicast

Method Details

updateAgentParameters

public void updateAgentParameters(String pUrl,
 Boolean pSecured)

Update agent connection data

Parameters:

pUrl - connection URL

pSecured - whether the connection is secured or not

setUrl

public void setUrl(String url)

setSecured

public void setSecured(Boolean pSecured)

isInitRequired

public boolean isInitRequired()

Check if either url or security information is missing.

Returns:

true if url or security information is missing and the initialization has not already be done

isUrlMissing

public boolean isUrlMissing()

isSecuredMissing

public boolean isSecuredMissing()

seal

public void seal()

Seal this details so that no further updates are possible

getAgentId

public String getAgentId()

Get the ID specific for these agent

Returns:

unique id identifying this agent or null if no ID was given.

toJSONObject

public org.json.simple.JSONObject toJSONObject()

Get the details as JSON Object

Returns:

the details JSON object

toString

public String toString()

Overrides:

toString in class Object