|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object oracle.odi.domain.support.BusinessObject oracle.odi.domain.support.AbstractRepositoryEntity oracle.odi.domain.support.AbstractOdiEntity oracle.odi.domain.topology.OdiPhysicalAgent
public class OdiPhysicalAgent
An ODI physical agent, holding metadata about a deployed runtime agent.
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 |
---|
public static final java.lang.String DEFAULT_APPLICATION_NAME
Constructor Detail |
---|
public OdiPhysicalAgent(java.lang.String pAgentName)
OdiPhysicalAgent
with the given name.
pAgentName
- the agent nameMethod Detail |
---|
public void addLoadBalancingAgent(OdiPhysicalAgent pAgent)
OdiPhysicalAgent
.
This basically defines given OdiPhysicalAgent
as slave of this OdiPhysicalAgent
.
pAgent
- an agentpublic java.lang.String getApplicationName()
setApplicationName(String)
public java.lang.String getHostName()
setHostName(String)
public int getHostPort()
setHostPort(int)
public java.io.Serializable getInternalId()
IRepositoryEntity
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.
getInternalId
in interface IRepositoryEntity
public java.util.Collection<OdiPhysicalAgent> getLoadBalancingAgents()
OdiPhysicalAgent
public java.util.Collection<OdiPhysicalAgent> getMasterAgents()
OdiPhysicalAgent
managing load balancing for this agent.public int getMaxConcurrentSessionCount()
setMaxConcurrentSessionCount(int)
public java.lang.String getName()
IOdiEntity
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
public java.lang.Number getPhysicalAgentId()
OdiPhysicalAgent
ID.
public java.lang.String getProtocol()
setProtocol(String)
public IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.lang.String getURLString()
public boolean isLoadBalancingEnabled()
true
if this agent will manage load balancing, false
otherwisepublic void removeLoadBalancingAgent(OdiPhysicalAgent pAgent)
OdiPhysicalAgent
.
pAgent
- an agentpublic void setApplicationName(java.lang.String pApplicationName)
By default that name is DEFAULT_APPLICATION_NAME
.
pApplicationName
- the application name used to deployed this agentgetApplicationName()
public void setHostName(java.lang.String pHostName)
OdiPhysicalAgent
.
pHostName
- the host namegetHostName()
public void setHostPort(int pHostPort)
By default, that value is set to 8080.
pHostPort
- the server host portgetHostPort()
public void setMaxConcurrentSessionCount(int pMaxConcurrentSessionCount)
The default value for that property is 1000.
Value should be positive (more than 0).
pMaxConcurrentSessionCount
- the max concurrent sessions
{@link
- IllegalArgumentException} if pMaxConcurrentSessionCount is less or equal to 0getMaxConcurrentSessionCount()
public void setProtocol(java.lang.String pProtocol)
By default, that value is set to HTTP.
pProtocol
- the protocolgetProtocol()
public boolean shouldExecuteSessions()
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.
true
if this agent should execute session itself, false
otherwise
|
Oracle® Data Integrator Java API Reference 11g Release 1 (11.1.1.3.0) E17060-01 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |