public interface AgentConfig
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
ACCESS_TOKEN_PROVIDER_NAME
Name of the access token provider.
|
static java.lang.String |
ACCESS_TOKEN_PROVIDER_PID
Deprecated.
Use ACCESS_TOKEN_PROVIDER_NAME
|
static java.lang.String |
AGENT_ALIAS_UPDATE |
static java.lang.String |
AGENT_DESCRIPTION |
static java.lang.String |
AGENT_ENABLED |
static java.lang.String |
AGENT_LOG_LEVEL |
static java.lang.String |
AGENT_MAINTENANCE |
static java.lang.String |
AGENT_NAME |
static java.lang.String |
AGENT_NO_STATUS_UPDATE |
static java.lang.String |
AGENT_NO_VERSIONS |
static java.lang.String |
AGENT_USER_ID |
static java.lang.String |
CQ_DISTRIBUTE |
static java.lang.String |
ENABLE_OAUTH |
static java.lang.String |
PROTOCOL_CONNECT_TIMEOUT |
static java.lang.String |
PROTOCOL_HTTP_CONNECTION_CLOSE |
static java.lang.String |
PROTOCOL_HTTP_HEADERS |
static java.lang.String |
PROTOCOL_HTTP_METHOD |
static java.lang.String |
PROTOCOL_HTTPS_EXPIRED |
static java.lang.String |
PROTOCOL_HTTPS_RELAXED |
static java.lang.String |
PROTOCOL_INTERFACE |
static java.lang.String |
PROTOCOL_SOCKET_TIMEOUT |
static java.lang.String |
PROTOCOL_VERSION |
static java.lang.String |
PROXY_HOST |
static java.lang.String |
PROXY_NTLM_DOMAIN |
static java.lang.String |
PROXY_NTLM_HOST |
static java.lang.String |
PROXY_PASS |
static java.lang.String |
PROXY_PORT |
static java.lang.String |
PROXY_USER |
static java.lang.String |
QUEUE_BATCH_MAX_SIZE |
static java.lang.String |
QUEUE_BATCH_MODE |
static java.lang.String |
QUEUE_BATCH_WAIT_TIME |
static java.lang.String |
QUEUE_MAX_RETRIES
Deprecated.
- this is not used anymore.
|
static java.lang.String |
QUEUE_RETRY_DELAY |
static java.lang.String |
REVERSE_REPLICATION |
static java.lang.String |
SERIALIZATION_TYPE |
static java.lang.String |
SSL_CONFIG |
static java.lang.String |
SSL_CONFIG_CLIENT_AUTH
Use to enable SSL client authentication.
|
static java.lang.String |
SSL_CONFIG_DEFAULT
Use default settings.
|
static java.lang.String |
SSL_CONFIG_RELAXED
Use to accept self-certified SSL certificates.
|
static java.lang.String |
TRANSPORT_NTLM_DOMAIN |
static java.lang.String |
TRANSPORT_NTLM_HOST |
static java.lang.String |
TRANSPORT_PASSWORD |
static java.lang.String |
TRANSPORT_URI |
static java.lang.String |
TRANSPORT_USER |
static java.lang.String |
TRIGGER_DISTRIBUTE |
static java.lang.String |
TRIGGER_MODIFIED |
static java.lang.String |
TRIGGER_ONOFFTIME |
static java.lang.String |
TRIGGER_RECEIVE |
static java.lang.String |
TRIGGER_SPECIFIC |
Modifier and Type | Method and Description |
---|---|
boolean |
aliasUpdate()
Determines if a replication with this agent should also replicate aliases, vanity URLs.
|
boolean |
allowsExpiredCertificates()
Checks whether the agent allows the use of expired certificates or not.
|
void |
checkValid()
Checks if the configuration is valid and throws an exception if not.
|
java.lang.String |
getAgentId()
Returns the id for the agent of this configuration.
|
java.lang.String |
getAgentUserId()
The id of the user that is used to build the replication content.
|
java.lang.String[] |
getAllTransportURIs()
The list of alternative destination URI.
|
long |
getBatchMaxSize()
If batch mode is enabled for this agent, this method returns a positive byte size.
|
long |
getBatchWaitTime()
If batch mode is enabled for this agent, this method returns a positive number in seconds.
|
AgentConfigGroup |
getConfigGroup()
Returns the group of this configuration
|
java.lang.String |
getConfigPath()
Returns the path to the configuration node.
|
java.lang.String |
getId()
Returns the id of this configuration.
|
java.lang.String |
getLogLevel()
The current log level - DEBUG, INFO, or ERROR.
|
int |
getMaxRetries()
Deprecated.
This is handled by the queue configuration
|
java.lang.String |
getName()
The descriptive name of this replication agent.
|
ValueMap |
getProperties()
Returns All agent properties as value map.
|
long |
getRetryDelay()
The retry delay in milliseconds.
|
java.lang.String |
getSerializationType()
The name of the serialization type.
|
java.lang.String |
getSSLConfig()
Returns SSL config mode.
|
java.lang.String |
getTransportPassword()
The target user password for delivering the content.
|
java.lang.String |
getTransportURI()
The destination URI.
|
java.lang.String |
getTransportUser()
The target user name for delivering the content.
|
boolean |
isBatchMode()
Returns if the replication by this agent is performed in batch mode.
|
boolean |
isEnabled()
Checks if this agent is enabled This is a convenience method and returns the property
AGENT_ENABLED . |
boolean |
isInMaintenanceMode()
Checks if this agent is in maintenance mode This is a convenience method and returns the property
AGENT_MAINTENANCE . |
boolean |
isOAuthEnabled()
Checks whether the agent is using the OAuth 2.0 Authorization Grants mechanism or not.
|
boolean |
isSpecific()
Checks if this agent is used for specific applications.
|
boolean |
isTriggeredOnDistribute()
Checks if this agent is used when a property "cq:distribute" has been modified.
|
boolean |
isTriggeredOnModification()
Checks if this agent is used for "replicate on modification".
|
boolean |
isTriggeredOnOffTime()
Checks if this agent is used for "replicate if on-/offtime reached".
|
boolean |
isTriggeredOnReceive()
Determines if a replication with this agent should be triggered once the replication request is received.
|
boolean |
noStatusUpdate()
Determines if a replication with this agent should suppress update of the replication status.
|
boolean |
noVersions()
Determines if a replication with this agent should suppress implicit versioning.
|
boolean |
usedForReverseReplication()
Checks if this agent is used for reverse replication.
|
static final java.lang.String AGENT_NAME
static final java.lang.String AGENT_DESCRIPTION
static final java.lang.String AGENT_ENABLED
static final java.lang.String AGENT_LOG_LEVEL
static final java.lang.String AGENT_USER_ID
static final java.lang.String TRIGGER_SPECIFIC
static final java.lang.String TRIGGER_MODIFIED
static final java.lang.String TRIGGER_ONOFFTIME
static final java.lang.String TRIGGER_DISTRIBUTE
static final java.lang.String REVERSE_REPLICATION
static final java.lang.String TRIGGER_RECEIVE
static final java.lang.String QUEUE_RETRY_DELAY
static final java.lang.String QUEUE_BATCH_MODE
static final java.lang.String QUEUE_BATCH_WAIT_TIME
static final java.lang.String QUEUE_BATCH_MAX_SIZE
@Deprecated static final java.lang.String QUEUE_MAX_RETRIES
static final java.lang.String SERIALIZATION_TYPE
static final java.lang.String TRANSPORT_URI
static final java.lang.String TRANSPORT_USER
static final java.lang.String TRANSPORT_PASSWORD
static final java.lang.String TRANSPORT_NTLM_DOMAIN
static final java.lang.String TRANSPORT_NTLM_HOST
static final java.lang.String PROTOCOL_VERSION
static final java.lang.String PROTOCOL_CONNECT_TIMEOUT
static final java.lang.String PROTOCOL_INTERFACE
static final java.lang.String PROTOCOL_SOCKET_TIMEOUT
static final java.lang.String PROXY_HOST
static final java.lang.String PROXY_PORT
static final java.lang.String PROXY_USER
static final java.lang.String PROXY_PASS
static final java.lang.String PROXY_NTLM_DOMAIN
static final java.lang.String PROXY_NTLM_HOST
static final java.lang.String PROTOCOL_HTTP_HEADERS
static final java.lang.String PROTOCOL_HTTP_METHOD
static final java.lang.String PROTOCOL_HTTP_CONNECTION_CLOSE
static final java.lang.String PROTOCOL_HTTPS_RELAXED
static final java.lang.String PROTOCOL_HTTPS_EXPIRED
static final java.lang.String ENABLE_OAUTH
@Deprecated static final java.lang.String ACCESS_TOKEN_PROVIDER_PID
static final java.lang.String ACCESS_TOKEN_PROVIDER_NAME
static final java.lang.String SSL_CONFIG
static final java.lang.String SSL_CONFIG_DEFAULT
static final java.lang.String SSL_CONFIG_RELAXED
static final java.lang.String SSL_CONFIG_CLIENT_AUTH
static final java.lang.String CQ_DISTRIBUTE
static final java.lang.String AGENT_NO_VERSIONS
static final java.lang.String AGENT_NO_STATUS_UPDATE
static final java.lang.String AGENT_MAINTENANCE
static final java.lang.String AGENT_ALIAS_UPDATE
void checkValid()
java.lang.IllegalArgumentException
- if not valid.java.lang.String getId()
java.lang.String getAgentId()
java.lang.String getConfigPath()
null
is returned.null
java.lang.String getName()
AGENT_NAME
AgentConfigGroup getConfigGroup()
java.lang.String getTransportURI()
TRANSPORT_URI
.java.lang.String[] getAllTransportURIs()
TRANSPORT_URI
as a comma separated list.java.lang.String getTransportUser()
TRANSPORT_USER
.java.lang.String getTransportPassword()
TRANSPORT_PASSWORD
.java.lang.String getSerializationType()
ContentBuilder
with this name must be registered. This is a convenience
method and returns the property SERIALIZATION_TYPE
.java.lang.String getAgentUserId()
AGENT_USER_ID
.null
long getRetryDelay()
QUEUE_RETRY_DELAY
.boolean isEnabled()
AGENT_ENABLED
.true
if this agent is enabledjava.lang.String getLogLevel()
AGENT_LOG_LEVEL
.@Deprecated int getMaxRetries()
QUEUE_MAX_RETRIES
.boolean isBatchMode()
long getBatchWaitTime()
long getBatchMaxSize()
boolean isSpecific()
TRIGGER_SPECIFIC
.true
if agent is specificboolean isTriggeredOnModification()
true
each modification to the content will
trigger a replication action on this agent. This is a convenience method and returns the property TRIGGER_MODIFIED
.true
if this agent auto replicates on modification.boolean isTriggeredOnOffTime()
true
any content that reached an
on-/offtime boundary will trigger a replication action on this agent. This is a convenience method and returns the property TRIGGER_ONOFFTIME
.true
if this agent auto replicates when on-/offtime reachedboolean isTriggeredOnDistribute()
TRIGGER_DISTRIBUTE
.true
if this agent replicates on this property changeboolean usedForReverseReplication()
REVERSE_REPLICATION
.true
if this agent is used for reverse replication.boolean noVersions()
Determines if a replication with this agent should suppress implicit versioning. If all participating agents of a replication specify this flag, the respective flags are set in the replication options passed to the preprocessors.
This is a convenience method and returns the property AGENT_NO_VERSIONS
.
true
if a replication with this agent should not trigger implicit versioning.boolean noStatusUpdate()
Determines if a replication with this agent should suppress update of the replication status. If all participating agents of a replication specify this flag, the replication status is not updated after a replication.
This is a convenience method and returns the property AGENT_NO_STATUS_UPDATE
.
true
if a replication with this agent should not update the replication status.ValueMap getProperties()
boolean isTriggeredOnReceive()
true
if the agent should be triggered once replication is receivedboolean isInMaintenanceMode()
AGENT_MAINTENANCE
.true
if this agent is in maintenance modeboolean aliasUpdate()
true
if agent should handle replication for aliases, vanity URLsjava.lang.String getSSLConfig()
SSL_CONFIG
boolean allowsExpiredCertificates()
true
if the agent accepts expired certificates, false
otherwiseboolean isOAuthEnabled()
ENABLE_OAUTH
true
if the authorization grants mechanism is enabledCopyright © 2010 - 2020 Adobe. All Rights Reserved