AgentConfig ("The Adobe AEM Quickstart and Web Application.")

```
public interface AgentConfig
```
The configuration of a replication agent.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`ACCESS_TOKEN_PROVIDER_PID`
`static String`	`AGENT_ALIAS_UPDATE`
`static String`	`AGENT_DESCRIPTION`
`static String`	`AGENT_ENABLED`
`static String`	`AGENT_LOG_LEVEL`
`static String`	`AGENT_MAINTENANCE`
`static String`	`AGENT_NAME`
`static String`	`AGENT_NO_STATUS_UPDATE`
`static String`	`AGENT_NO_VERSIONS`
`static String`	`AGENT_USER_ID`
`static String`	`CQ_DISTRIBUTE`
`static String`	`ENABLE_OAUTH`
`static String`	`PROTOCOL_CONNECT_TIMEOUT`
`static String`	`PROTOCOL_HTTP_CONNECTION_CLOSE`
`static String`	`PROTOCOL_HTTP_HEADERS`
`static String`	`PROTOCOL_HTTP_METHOD`
`static String`	`PROTOCOL_HTTPS_EXPIRED`
`static String`	`PROTOCOL_HTTPS_RELAXED`
`static String`	`PROTOCOL_INTERFACE`
`static String`	`PROTOCOL_SOCKET_TIMEOUT`
`static String`	`PROTOCOL_VERSION`
`static String`	`PROXY_HOST`
`static String`	`PROXY_NTLM_DOMAIN`
`static String`	`PROXY_NTLM_HOST`
`static String`	`PROXY_PASS`
`static String`	`PROXY_PORT`
`static String`	`PROXY_USER`
`static String`	`QUEUE_BATCH_MAX_SIZE`
`static String`	`QUEUE_BATCH_MODE`
`static String`	`QUEUE_BATCH_WAIT_TIME`
`static String`	`QUEUE_MAX_RETRIES` Deprecated. - this is not used anymore.
`static String`	`QUEUE_RETRY_DELAY`
`static String`	`REVERSE_REPLICATION`
`static String`	`SERIALIZATION_TYPE`
`static String`	`SSL_CONFIG`
`static String`	`SSL_CONFIG_CLIENT_AUTH` Use to enable SSL client authentication.
`static String`	`SSL_CONFIG_DEFAULT` Use default settings.
`static String`	`SSL_CONFIG_RELAXED` Use to accept self-certified SSL certificates.
`static String`	`TRANSPORT_NTLM_DOMAIN`
`static String`	`TRANSPORT_NTLM_HOST`
`static String`	`TRANSPORT_PASSWORD`
`static String`	`TRANSPORT_URI`
`static String`	`TRANSPORT_USER`
`static String`	`TRIGGER_DISTRIBUTE`
`static String`	`TRIGGER_MODIFIED`
`static String`	`TRIGGER_ONOFFTIME`
`static String`	`TRIGGER_RECEIVE`
`static String`	`TRIGGER_SPECIFIC`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
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.
`String`	`getAgentId()` Returns the id for the agent of this configuration.
`String`	`getAgentUserId()` The id of the user that is used to build the replication content.
`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
`String`	`getConfigPath()` Returns the path to the configuration node.
`String`	`getId()` Returns the id of this configuration.
`String`	`getLogLevel()` The current log level - DEBUG, INFO, or ERROR.
`int`	`getMaxRetries()` Deprecated. This is handled by the queue configuration
`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.
`String`	`getSerializationType()` The name of the serialization type.
`String`	`getSSLConfig()` Returns SSL config mode.
`String`	`getTransportPassword()` The target user password for delivering the content.
`String`	`getTransportURI()` The destination URI.
`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.

- Field Detail
  - AGENT_NAME
```
static final String AGENT_NAME
```
    See Also:
    
    Constant Field Values
  - AGENT_DESCRIPTION
```
static final String AGENT_DESCRIPTION
```
    See Also:
    
    Constant Field Values
  - AGENT_ENABLED
```
static final String AGENT_ENABLED
```
    See Also:
    
    Constant Field Values
  - AGENT_LOG_LEVEL
```
static final String AGENT_LOG_LEVEL
```
    See Also:
    
    Constant Field Values
  - AGENT_USER_ID
```
static final String AGENT_USER_ID
```
    See Also:
    
    Constant Field Values
  - TRIGGER_SPECIFIC
```
static final String TRIGGER_SPECIFIC
```
    See Also:
    
    Constant Field Values
  - TRIGGER_MODIFIED
```
static final String TRIGGER_MODIFIED
```
    See Also:
    
    Constant Field Values
  - TRIGGER_ONOFFTIME
```
static final String TRIGGER_ONOFFTIME
```
    See Also:
    
    Constant Field Values
  - TRIGGER_DISTRIBUTE
```
static final String TRIGGER_DISTRIBUTE
```
    See Also:
    
    Constant Field Values
  - REVERSE_REPLICATION
```
static final String REVERSE_REPLICATION
```
    See Also:
    
    Constant Field Values
  - TRIGGER_RECEIVE
```
static final String TRIGGER_RECEIVE
```
    See Also:
    
    Constant Field Values
  - QUEUE_RETRY_DELAY
```
static final String QUEUE_RETRY_DELAY
```
    See Also:
    
    Constant Field Values
  - QUEUE_BATCH_MODE
```
static final String QUEUE_BATCH_MODE
```
    See Also:
    
    Constant Field Values
  - QUEUE_BATCH_WAIT_TIME
```
static final String QUEUE_BATCH_WAIT_TIME
```
    See Also:
    
    Constant Field Values
  - QUEUE_BATCH_MAX_SIZE
```
static final String QUEUE_BATCH_MAX_SIZE
```
    See Also:
    
    Constant Field Values
  - QUEUE_MAX_RETRIES
```
@Deprecated
static final String QUEUE_MAX_RETRIES
```
    Deprecated. - this is not used anymore.
    
    See Also:
    
    Constant Field Values
  - SERIALIZATION_TYPE
```
static final String SERIALIZATION_TYPE
```
    See Also:
    
    Constant Field Values
  - TRANSPORT_URI
```
static final String TRANSPORT_URI
```
    See Also:
    
    Constant Field Values
  - TRANSPORT_USER
```
static final String TRANSPORT_USER
```
    See Also:
    
    Constant Field Values
  - TRANSPORT_PASSWORD
```
static final String TRANSPORT_PASSWORD
```
    See Also:
    
    Constant Field Values
  - TRANSPORT_NTLM_DOMAIN
```
static final String TRANSPORT_NTLM_DOMAIN
```
    See Also:
    
    Constant Field Values
  - TRANSPORT_NTLM_HOST
```
static final String TRANSPORT_NTLM_HOST
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_VERSION
```
static final String PROTOCOL_VERSION
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_CONNECT_TIMEOUT
```
static final String PROTOCOL_CONNECT_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_INTERFACE
```
static final String PROTOCOL_INTERFACE
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_SOCKET_TIMEOUT
```
static final String PROTOCOL_SOCKET_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - PROXY_HOST
```
static final String PROXY_HOST
```
    See Also:
    
    Constant Field Values
  - PROXY_PORT
```
static final String PROXY_PORT
```
    See Also:
    
    Constant Field Values
  - PROXY_USER
```
static final String PROXY_USER
```
    See Also:
    
    Constant Field Values
  - PROXY_PASS
```
static final String PROXY_PASS
```
    See Also:
    
    Constant Field Values
  - PROXY_NTLM_DOMAIN
```
static final String PROXY_NTLM_DOMAIN
```
    See Also:
    
    Constant Field Values
  - PROXY_NTLM_HOST
```
static final String PROXY_NTLM_HOST
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_HTTP_HEADERS
```
static final String PROTOCOL_HTTP_HEADERS
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_HTTP_METHOD
```
static final String PROTOCOL_HTTP_METHOD
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_HTTP_CONNECTION_CLOSE
```
static final String PROTOCOL_HTTP_CONNECTION_CLOSE
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_HTTPS_RELAXED
```
static final String PROTOCOL_HTTPS_RELAXED
```
    See Also:
    
    Constant Field Values
  - PROTOCOL_HTTPS_EXPIRED
```
static final String PROTOCOL_HTTPS_EXPIRED
```
    See Also:
    
    Constant Field Values
  - ENABLE_OAUTH
```
static final String ENABLE_OAUTH
```
    See Also:
    
    Constant Field Values
  - ACCESS_TOKEN_PROVIDER_PID
```
static final String ACCESS_TOKEN_PROVIDER_PID
```
    See Also:
    
    Constant Field Values
  - SSL_CONFIG
```
static final String SSL_CONFIG
```
    See Also:
    
    Constant Field Values
  - SSL_CONFIG_DEFAULT
```
static final String SSL_CONFIG_DEFAULT
```
    Use default settings.
    
    See Also:
    
    Constant Field Values
  - SSL_CONFIG_RELAXED
```
static final String SSL_CONFIG_RELAXED
```
    Use to accept self-certified SSL certificates.
    
    See Also:
    
    Constant Field Values
  - SSL_CONFIG_CLIENT_AUTH
```
static final String SSL_CONFIG_CLIENT_AUTH
```
    Use to enable SSL client authentication.
    
    See Also:
    
    Constant Field Values
  - CQ_DISTRIBUTE
```
static final String CQ_DISTRIBUTE
```
    See Also:
    
    Constant Field Values
  - AGENT_NO_VERSIONS
```
static final String AGENT_NO_VERSIONS
```
    See Also:
    
    Constant Field Values
  - AGENT_NO_STATUS_UPDATE
```
static final String AGENT_NO_STATUS_UPDATE
```
    See Also:
    
    Constant Field Values
  - AGENT_MAINTENANCE
```
static final String AGENT_MAINTENANCE
```
    See Also:
    
    Constant Field Values
  - AGENT_ALIAS_UPDATE
```
static final String AGENT_ALIAS_UPDATE
```
    See Also:
    
    Constant Field Values
- Method Detail
  - checkValid
```
void checkValid()
```
    Checks if the configuration is valid and throws an exception if not. The message of the exception can be used as hint why the config is not valid.
    
    Throws:
    
    IllegalArgumentException - if not valid.
  - getId
```
String getId()
```
    Returns the id of this configuration.
    
    Returns:
    
    the id
  - getAgentId
```
String getAgentId()
```
    Returns the id for the agent of this configuration. note that there can be several configurations with the same agent id but in different groups (i.e. run modes).
    
    Returns:
    
    the agent id
  - getConfigPath
```
String getConfigPath()
```
    Returns the path to the configuration node. If the configuration is not stored in the repository, null is returned.
    
    Returns:
    
    the path to the config or null
  - getName
```
String getName()
```
    The descriptive name of this replication agent. This is a convenience method and returns the property AGENT_NAME
    
    Returns:
    
    agent name
  - getConfigGroup
```
AgentConfigGroup getConfigGroup()
```
    Returns the group of this configuration
    
    Returns:
    
    the config group
  - getTransportURI
```
String getTransportURI()
```
    The destination URI. This uri is one of those defined in the property TRANSPORT_URI.
    
    Returns:
    
    the destination URI.
  - getAllTransportURIs
```
String[] getAllTransportURIs()
```
    The list of alternative destination URI. This is a convenience method and returns the uris defined in the property TRANSPORT_URI as a comma separated list.
    
    Returns:
    
    the destination URI.
  - getTransportUser
```
String getTransportUser()
```
    The target user name for delivering the content. This is a convenience method and returns the property TRANSPORT_USER.
    
    Returns:
    
    transport user name
  - getTransportPassword
```
String getTransportPassword()
```
    The target user password for delivering the content. This is a convenience method and returns the property TRANSPORT_PASSWORD.
    
    Returns:
    
    plain text transport password
  - getSerializationType
```
String getSerializationType()
```
    The name of the serialization type. A corresponding ContentBuilder with this name must be registered. This is a convenience method and returns the property SERIALIZATION_TYPE.
    
    Returns:
    
    name of the content builder
  - getAgentUserId
```
String getAgentUserId()
```
    The id of the user that is used to build the replication content. This is a convenience method and returns the property AGENT_USER_ID.
    
    Returns:
    
    the userid or null
  - getRetryDelay
```
long getRetryDelay()
```
    The retry delay in milliseconds. This is a convenience method and returns the property QUEUE_RETRY_DELAY.
    
    Returns:
    
    retry delay.
  - isEnabled
```
boolean isEnabled()
```
    Checks if this agent is enabled This is a convenience method and returns the property AGENT_ENABLED.
    
    Returns:
    
    true if this agent is enabled
  - getLogLevel
```
String getLogLevel()
```
    The current log level - DEBUG, INFO, or ERROR. This is a convenience method and returns the property AGENT_LOG_LEVEL.
    
    Returns:
    
    log lever
  - getMaxRetries
```
@Deprecated
int getMaxRetries()
```
    Deprecated. This is handled by the queue configuration
    
    The number of retries before the replication is cancelled. This is a convenience method and returns the property QUEUE_MAX_RETRIES.
    
    Returns:
    
    The number of retries or -1 for endless retries.
  - isBatchMode
```
boolean isBatchMode()
```
    Returns if the replication by this agent is performed in batch mode.
    
    Returns:
    
    If the replication is performed in batch mode.
    
    Since:
    
    5.12.0
  - getBatchWaitTime
```
long getBatchWaitTime()
```
    If batch mode is enabled for this agent, this method returns a positive number in seconds. This time specifies the maximum wait time for a batch to be sent.
    
    Returns:
    
    The batch wait time in seconds.
    
    Since:
    
    5.12.0
  - getBatchMaxSize
```
long getBatchMaxSize()
```
    If batch mode is enabled for this agent, this method returns a positive byte size. With the first replication exceeding this size, the batch is sent.
    
    Returns:
    
    The maximum batch size in bytes.
    
    Since:
    
    5.12.0
  - isSpecific
```
boolean isSpecific()
```
    Checks if this agent is used for specific applications. Specific agents are used by the application for special application specific replications and are not used during a general replication. This is a convenience method and returns the property TRIGGER_SPECIFIC.
    
    Returns:
    
    true if agent is specific
  - isTriggeredOnModification
```
boolean isTriggeredOnModification()
```
    Checks if this agent is used for "replicate on modification". If this flag is 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.
    
    Returns:
    
    true if this agent auto replicates on modification.
  - isTriggeredOnOffTime
```
boolean isTriggeredOnOffTime()
```
    Checks if this agent is used for "replicate if on-/offtime reached". If this flag is 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.
    
    Returns:
    
    true if this agent auto replicates when on-/offtime reached
  - isTriggeredOnDistribute
```
boolean isTriggeredOnDistribute()
```
    Checks if this agent is used when a property "cq:distribute" has been modified. This is a convenience method and returns the property TRIGGER_DISTRIBUTE.
    
    Returns:
    
    true if this agent replicates on this property change
  - usedForReverseReplication
```
boolean usedForReverseReplication()
```
    Checks if this agent is used for reverse replication. This is a convenience method and returns the property REVERSE_REPLICATION.
    
    Returns:
    
    true if this agent is used for reverse replication.
  - noVersions
```
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.
    
    Returns:
    
    true if a replication with this agent should not trigger implicit versioning.
    
    Since:
    
    5.4
  - noStatusUpdate
```
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.
    
    Returns:
    
    true if a replication with this agent should not update the replication status.
    
    Since:
    
    5.4
  - getProperties
```
ValueMap getProperties()
```
    Returns All agent properties as value map.
    
    Returns:
    
    agent properties
  - isTriggeredOnReceive
```
boolean isTriggeredOnReceive()
```
    Determines if a replication with this agent should be triggered once the replication request is received. This is used particularly for chain replication
    
    Returns:
    
    true if the agent should be triggered once replication is received
    
    Since:
    
    5.5.19
  - isInMaintenanceMode
```
boolean isInMaintenanceMode()
```
    Checks if this agent is in maintenance mode This is a convenience method and returns the property AGENT_MAINTENANCE.
    
    Returns:
    
    true if this agent is in maintenance mode
  - aliasUpdate
```
boolean aliasUpdate()
```
    Determines if a replication with this agent should also replicate aliases, vanity URLs.
    
    Returns:
    
    true if agent should handle replication for aliases, vanity URLs
  - getSSLConfig
```
String getSSLConfig()
```
    Returns SSL config mode. Values are default, relaxed or clientauth.
    
    See Also:
    
    SSL_CONFIG
  - allowsExpiredCertificates
```
boolean allowsExpiredCertificates()
```
    Checks whether the agent allows the use of expired certificates or not.
    
    Returns:
    
    true if the agent accepts expired certificates, false otherwise
  - isOAuthEnabled
```
boolean isOAuthEnabled()
```
    Checks whether the agent is using the OAuth 2.0 Authorization Grants mechanism or not. This is a convenience method and returns the property ENABLE_OAUTH
    
    Returns:
    
    true if the authorization grants mechanism is enabled

Interface AgentConfig

Field Summary

Method Summary

Field Detail

AGENT_NAME

AGENT_DESCRIPTION

AGENT_ENABLED

AGENT_LOG_LEVEL

AGENT_USER_ID

TRIGGER_SPECIFIC

TRIGGER_MODIFIED

TRIGGER_ONOFFTIME

TRIGGER_DISTRIBUTE

REVERSE_REPLICATION

TRIGGER_RECEIVE

QUEUE_RETRY_DELAY

QUEUE_BATCH_MODE

QUEUE_BATCH_WAIT_TIME

QUEUE_BATCH_MAX_SIZE

QUEUE_MAX_RETRIES

SERIALIZATION_TYPE

TRANSPORT_URI

TRANSPORT_USER

TRANSPORT_PASSWORD

TRANSPORT_NTLM_DOMAIN

TRANSPORT_NTLM_HOST

PROTOCOL_VERSION

PROTOCOL_CONNECT_TIMEOUT

PROTOCOL_INTERFACE

PROTOCOL_SOCKET_TIMEOUT

PROXY_HOST

PROXY_PORT

PROXY_USER

PROXY_PASS

PROXY_NTLM_DOMAIN

PROXY_NTLM_HOST

PROTOCOL_HTTP_HEADERS

PROTOCOL_HTTP_METHOD

PROTOCOL_HTTP_CONNECTION_CLOSE

PROTOCOL_HTTPS_RELAXED

PROTOCOL_HTTPS_EXPIRED

ENABLE_OAUTH

ACCESS_TOKEN_PROVIDER_PID

SSL_CONFIG

SSL_CONFIG_DEFAULT

SSL_CONFIG_RELAXED

SSL_CONFIG_CLIENT_AUTH

CQ_DISTRIBUTE

AGENT_NO_VERSIONS

AGENT_NO_STATUS_UPDATE

AGENT_MAINTENANCE

AGENT_ALIAS_UPDATE

Method Detail

checkValid

getId

getAgentId

getConfigPath

getName

getConfigGroup

getTransportURI

getAllTransportURIs

getTransportUser

getTransportPassword

getSerializationType

getAgentUserId

getRetryDelay

isEnabled

getLogLevel

getMaxRetries

isBatchMode

getBatchWaitTime

getBatchMaxSize

isSpecific

isTriggeredOnModification

isTriggeredOnOffTime

isTriggeredOnDistribute

usedForReverseReplication

noVersions

noStatusUpdate

getProperties