public class OdiPhysicalAgent extends oracle.odi.domain.support.AbstractOdiEntity implements IMasterOdiEntity, oracle.odi.domain.impexp.IExportable, oracle.odi.impexp.smartie.ISmartExportable
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
DEFAULT_APPLICATION_NAME
Constant field value representing the default agent application name.
|
Constructor and Description |
---|
OdiPhysicalAgent(java.lang.String pAgentName)
Construct a new
OdiPhysicalAgent with the given name. |
Modifier and Type | Method and Description |
---|---|
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 |
getLoadBalancingAgents()
Obtains an unmodifiable collection of agents this agent can use to make load balancing.
|
java.util.Collection |
getMasterAgents()
Obtains an unmodifiable collection of agents that can use this agent to
make load balancing.
|
int |
getMaxCachedSessionBlueprintCount()
Obtains the maximum number of cache entries in Session Blueprint queue
for this Agent.
|
int |
getMaxCachedSessionBlueprintIdleTime()
Obtains amount of time in seconds during which the unused Session Blueprint can be
kept in the Agent's cache before removing.
|
int |
getMaxConcurrentSessionCount()
Obtains the maximum number of concurrent session the runtime agent can execute.
|
int |
getMaxConcurrentThreadCount()
Obtains the maximum concurrent thread count the runtime agent can execute.
|
int |
getMaxThreadPerSessionCount()
Obtains the maximum thread count the runtime agent can execute per session.
|
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 |
setMaxCachedSessionBlueprintCount(int pMaxCachedSessionBlueprintCount)
Defines the maximum number of cache entries in Session Blueprint queue
for this Agent.
|
void |
setMaxCachedSessionBlueprintIdleTime(int pMaxCachedSessionBlueprintIdleTime)
Specifies the maximum idle time in seconds for Session Blueprint in the Agent's cache.
|
void |
setMaxConcurrentSessionCount(int pMaxConcurrentSessionCount)
Defines the maximum number of concurrent sessions an agent can run before any load balancing.
|
void |
setMaxConcurrentThreadCount(int pMaxConcurrentThreadCount)
Defines the maximum concurrent thread count.
|
void |
setMaxThreadPerSessionCount(int pMaxThreadPerSessionCount)
Defines the maximum thread count the runtime agent can execute per session.
|
void |
setName(java.lang.String pAgentName)
Specifies the name for this
OdiPhysicalAgent . |
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.
|
equals, getFirstDate, getFirstUser, getInternalVersion, getLastDate, getLastUser, hashCode, isInstanceLevelSecurityNeeded, isNew, toString
getGlobalId, getNumericId, hasCustomizedPersistenceMethodFor, invokeCustomizedPersistenceMethodFor
getFirstDate, getFirstUser, getLastDate, getLastUser, isInstanceLevelSecurityNeeded
getGlobalId
public static final java.lang.String DEFAULT_APPLICATION_NAME
public OdiPhysicalAgent(java.lang.String pAgentName)
OdiPhysicalAgent
with the given name.pAgentName
- the agent namepublic void setName(java.lang.String pAgentName)
OdiPhysicalAgent
.
The name is used as an agent identifier in the Work Repository. Changing it may cause breaking of some references.
pAgentName
- namepublic 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.lang.String getApplicationName()
setApplicationName(String)
public void setApplicationName(java.lang.String pApplicationName)
By default that name is DEFAULT_APPLICATION_NAME
.
pApplicationName
- the application name used to deployed this agentgetApplicationName()
public java.lang.String getHostName()
setHostName(String)
public void setHostName(java.lang.String pHostName)
OdiPhysicalAgent
.pHostName
- the host namegetHostName()
public int getHostPort()
setHostPort(int)
public void setHostPort(int pHostPort)
By default, that value is set to 8080.
pHostPort
- the server host portgetHostPort()
public java.lang.String getProtocol()
setProtocol(String)
public void setProtocol(java.lang.String pProtocol)
By default, that value is set to HTTP.
pProtocol
- the protocolgetProtocol()
public java.lang.Number getPhysicalAgentId()
OdiPhysicalAgent
ID.public java.lang.String getName()
IOdiEntity
getName
in interface IOdiEntity
getName
in class oracle.odi.domain.support.AbstractOdiEntity
public java.lang.String getURLString()
public int getMaxConcurrentSessionCount()
setMaxConcurrentSessionCount(int)
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 addLoadBalancingAgent(OdiPhysicalAgent pAgent)
OdiPhysicalAgent
.
This basically defines given OdiPhysicalAgent
as slave of this OdiPhysicalAgent
.pAgent
- an agentpublic void removeLoadBalancingAgent(OdiPhysicalAgent pAgent)
OdiPhysicalAgent
.pAgent
- an agentpublic java.util.Collection getLoadBalancingAgents()
OdiPhysicalAgent
public boolean isLoadBalancingEnabled()
true
if this agent will manage load balancing, false
otherwisepublic 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
otherwisepublic IRepositoryEntity getSecurityContainer()
IRepositoryEntity
getSecurityContainer
in interface IRepositoryEntity
public java.util.Collection getMasterAgents()
OdiPhysicalAgent
managing load balancing for this agent.public int getMaxCachedSessionBlueprintCount()
setMaxCachedSessionBlueprintCount(int)
public void setMaxCachedSessionBlueprintCount(int pMaxCachedSessionBlueprintCount)
The default value for that property is 100.
Value should be positive or 0 (no limit).
pMaxCachedSessionBlueprintCount
- max number of session blueprint cache entriesgetMaxCachedSessionBlueprintCount()
public int getMaxCachedSessionBlueprintIdleTime()
setMaxCachedSessionBlueprintIdleTime(int)
public void setMaxCachedSessionBlueprintIdleTime(int pMaxCachedSessionBlueprintIdleTime)
The default value for that property is 600.
Value should be positive or 0 (no limit).
pMaxCachedSessionBlueprintIdleTime
- max idle timegetMaxCachedSessionBlueprintIdleTime()
public int getMaxConcurrentThreadCount()
The default value for that property is 1000.
setMaxConcurrentThreadCount(int)
public void setMaxConcurrentThreadCount(int pMaxConcurrentThreadCount)
The default value for that property is 1000.
Value should be positive (more than 0).
Value should be not less than agent's maximum number of concurrent sessions.
pMaxConcurrentThreadCount
- maximum concurrent thread countgetMaxConcurrentThreadCount()
,
getMaxConcurrentSessionCount()
,
setMaxConcurrentSessionCount(int)
public int getMaxThreadPerSessionCount()
The default value for that property is 0, meaning no limit.
setMaxThreadPerSessionCount(int)
,
getMaxConcurrentThreadCount()
,
setMaxConcurrentThreadCount(int)
public void setMaxThreadPerSessionCount(int pMaxThreadPerSessionCount)
The default value for that property is 0, meaning no limit.
Value should not be negative.
Value should be not less than agent's maximum concurrent thread count.
pMaxThreadPerSessionCount
- maximum thread count per session