Skip navigation links

oracle.odi.domain.topology
Class OdiPhysicalAgent

java.lang.Object
oracle.odi.domain.support.BusinessObject
oracle.odi.domain.support.AbstractRepositoryEntity
oracle.odi.domain.support.AbstractOdiEntity
oracle.odi.domain.topology.OdiPhysicalAgent

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, IMasterOdiEntity, IExportable, IOdiEntity, IRepositoryEntity, ISmartExportable

public class OdiPhysicalAgent

extends oracle.odi.domain.support.AbstractOdiEntity

implements IMasterOdiEntity, IExportable, ISmartExportable

An ODI physical agent, holding metadata about a deployed runtime agent.

Since:

11.1.1.3.0

See Also:

Serialized Form

Field Summary

static java.lang.String

DEFAULT_APPLICATION_NAME Constant field value representing the default agent application name.

Fields inherited from class oracle.odi.domain.support.AbstractOdiEntity

STARTING_INTERNAL_VERSION

Constructor Summary

OdiPhysicalAgent(java.lang.String pAgentName)
Construct a new OdiPhysicalAgent with the given name.

Method Summary

void	addLoadBalancingAgent(OdiPhysicalAgent pAgent) Add given agent to the collection of load balancing agents related to this OdiPhysicalAgent.
java.lang.String	getApplicationName() Obtains the name of the runtime agent application.
java.lang.String	getHostName() Obtains the runtime agent host name.
int	getHostPort() Obtains the runtime agent's host port.
java.io.Serializable	getInternalId() Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.
java.util.Collection<OdiPhysicalAgent>	getLoadBalancingAgents() Obtains an unmodifiable collection of agents this agent can use to make load balancing.
java.util.Collection<OdiPhysicalAgent>	getMasterAgents() Obtains an unmodifiable collection of agents that can use this agent to make load balancing.
int	getMaxConcurrentSessionCount() Obtains the maximum number of concurrent session the runtime agent can execute.
java.lang.String	getName() Returns the name of this entity instance.
java.lang.Number	getPhysicalAgentId() This OdiPhysicalAgent ID.
java.lang.String	getProtocol() Obtains the protocol to be used to communicate with the runtime agent.
IRepositoryEntity	getSecurityContainer() Define a generic way to retrieve container for entities.
java.lang.String	getURLString() Obtains the string representation of the URL to locate the deployed runtime agent.
boolean	isLoadBalancingEnabled() Returns whether this agent's load balancing is enabled (i.e.
void	removeLoadBalancingAgent(OdiPhysicalAgent pAgent) Remove given agent to the collection of load balancing agents related to this OdiPhysicalAgent.
void	setApplicationName(java.lang.String pApplicationName) Define the J2EE Application name of this agent.
void	setHostName(java.lang.String pHostName) Defines the host name for this OdiPhysicalAgent.
void	setHostPort(int pHostPort) Define the host port of the server where that agent is or will be deployed.
void	setMaxConcurrentSessionCount(int pMaxConcurrentSessionCount) Defines the maximum number of concurrent sessions an agent can run before any load balancing.
void	setProtocol(java.lang.String pProtocol) Define the protocol to be used to ping that agent.
boolean	shouldExecuteSessions() Returns whether this agent should execute sessions or always delegate execution to load balancing agents.

Methods inherited from class oracle.odi.domain.support.AbstractOdiEntity

equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isInstanceLevelSecurityNeeded, isNew, toString

Methods inherited from class oracle.odi.domain.support.BusinessObject

clone

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface oracle.odi.domain.IOdiEntity

getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded

Field Detail

DEFAULT_APPLICATION_NAME

public static final java.lang.String DEFAULT_APPLICATION_NAME

Constant field value representing the default agent application name.

See Also:

Constant Field Values

Constructor Detail

OdiPhysicalAgent

public OdiPhysicalAgent(java.lang.String pAgentName)

Construct a new OdiPhysicalAgent with the given name.

Parameters:

pAgentName - the agent name

Method Detail

getInternalId

public java.io.Serializable getInternalId()

Description copied from interface: IRepositoryEntity

Provides a common getter for the persistence layer to obtain an identity, irrespective of the actual type of identity used.

Typically a subclass will delegate to a public SomePrimitiveWrapper getId() method. The necessity for the getInternalId() abstract method is solely because the persistence layer needs a way of obtaining the identity irrespective of the actual identity implementation choice.

Returning null from this method will indicate the object has never been saved. This will likely be relied on by some DAO implementations.

Specified by:

getInternalId in interface IRepositoryEntity

Returns:

the persistence identity of this instance

getApplicationName

public java.lang.String getApplicationName()

Obtains the name of the runtime agent application.

Returns:

agent's application name

See Also:

setApplicationName(String)

setApplicationName

public void setApplicationName(java.lang.String pApplicationName)

Define the J2EE Application name of this agent.

By default that name is DEFAULT_APPLICATION_NAME.

Parameters:

pApplicationName - the application name used to deployed this agent

See Also:

getApplicationName()

getHostName

public java.lang.String getHostName()

Obtains the runtime agent host name.

Returns:

host name

See Also:

setHostName(String)

setHostName

public void setHostName(java.lang.String pHostName)

Defines the host name for this OdiPhysicalAgent.

Parameters:

pHostName - the host name

See Also:

getHostName()

getHostPort

public int getHostPort()

Obtains the runtime agent's host port.

Returns:

host port

See Also:

setHostPort(int)

setHostPort

public void setHostPort(int pHostPort)

Define the host port of the server where that agent is or will be deployed.

By default, that value is set to 8080.

Parameters:

pHostPort - the server host port

See Also:

getHostPort()

getProtocol

public java.lang.String getProtocol()

Obtains the protocol to be used to communicate with the runtime agent.

Returns:

protocol name

See Also:

setProtocol(String)

setProtocol

public void setProtocol(java.lang.String pProtocol)

Define the protocol to be used to ping that agent.

By default, that value is set to HTTP.

Parameters:

pProtocol - the protocol

See Also:

getProtocol()

getPhysicalAgentId

public java.lang.Number getPhysicalAgentId()

This OdiPhysicalAgent ID.

Returns:

the id

getName

public java.lang.String getName()

Description copied from interface: IOdiEntity

Returns the name of this entity instance.

Specified by:

getName in interface IOdiEntity

Overrides:

getName in class oracle.odi.domain.support.AbstractOdiEntity

Returns:

the name

getURLString

public java.lang.String getURLString()

Obtains the string representation of the URL to locate the deployed runtime agent.

Returns:

the url of the runtime agent as [protocol]://[hostName]:[hostPort]/[applicationName].

getMaxConcurrentSessionCount

public int getMaxConcurrentSessionCount()

Obtains the maximum number of concurrent session the runtime agent can execute.

Returns:

maximum concurrent session execution

See Also:

setMaxConcurrentSessionCount(int)

setMaxConcurrentSessionCount

public void setMaxConcurrentSessionCount(int pMaxConcurrentSessionCount)

Defines the maximum number of concurrent sessions an agent can run before any load balancing.

The default value for that property is 1000.

Value should be positive (more than 0).

Parameters:

pMaxConcurrentSessionCount - the max concurrent sessions

Throws:

{@link - IllegalArgumentException} if pMaxConcurrentSessionCount is less or equal to 0

See Also:

getMaxConcurrentSessionCount()

addLoadBalancingAgent

public void addLoadBalancingAgent(OdiPhysicalAgent pAgent)

Add given agent to the collection of load balancing agents related to this OdiPhysicalAgent. This basically defines given OdiPhysicalAgent as slave of this OdiPhysicalAgent.

Parameters:

pAgent - an agent

removeLoadBalancingAgent

public void removeLoadBalancingAgent(OdiPhysicalAgent pAgent)

Remove given agent to the collection of load balancing agents related to this OdiPhysicalAgent.

Parameters:

pAgent - an agent

getLoadBalancingAgents

public java.util.Collection<OdiPhysicalAgent> getLoadBalancingAgents()

Obtains an unmodifiable collection of agents this agent can use to make load balancing.

Returns:

a collection of OdiPhysicalAgent

isLoadBalancingEnabled

public boolean isLoadBalancingEnabled()

Returns whether this agent's load balancing is enabled (i.e. whether there are some load balanced - aka slave - agents defined), or not.

Returns:

true if this agent will manage load balancing, false otherwise

shouldExecuteSessions

public boolean shouldExecuteSessions()

Returns whether this agent should execute sessions or always delegate execution to load balancing agents.

Note: if load balancing is disabled for this agent, that method will always return true. If load balancing is enabled, that method will return true if and only if this agent is itself referenced as load balancing agent.

Returns:

true if this agent should execute session itself, false otherwise

getSecurityContainer

public IRepositoryEntity getSecurityContainer()

Description copied from interface: IRepositoryEntity

Define a generic way to retrieve container for entities.

Specified by:

getSecurityContainer in interface IRepositoryEntity

Returns:

container entity

getMasterAgents

public java.util.Collection<OdiPhysicalAgent> getMasterAgents()

Obtains an unmodifiable collection of agents that can use this agent to make load balancing.

Returns:

a Collection of OdiPhysicalAgent managing load balancing for this agent.

Skip navigation links