OpenSSOAgentBootstrap.template revision 504576c0cd21165cc879543ca89164d214acf996
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Copyright (c) 2008 Sun Microsystems Inc. All Rights Reserved
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User# The contents of this file are subject to the terms
5347c0fcb04eaea19d9f39795646239f487c6207Tinderbox User# of the Common Development and Distribution License
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# (the License). You may not use this file except in
d6fa26d0adaec6c910115be34fe7a5a5f402c14fMark Andrews# compliance with the License.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# You can obtain a copy of the License at
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User# https://opensso.dev.java.net/public/CDDLv1.0.html or
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# See the License for the specific language governing
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# permission and limitations under the License.
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User# When distributing Covered Code, include this CDDL
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Header Notice in each file and include the License file
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# If applicable, add the following below the CDDL Header,
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# with the fields enclosed by brackets [] replaced by
cd32f419a8a5432fbb139f56ee73cbf68b9350ccTinderbox User# your own identifying information:
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# "Portions Copyrighted [year] [name of copyright owner]"
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# $Id: OpenSSOAgentBootstrap.template,v 1.1 2008/11/28 12:26:12 saueree Exp $
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# Portions Copyrighted 2010-2013 ForgeRock AS.
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein#------------------------------------------------------------------------------
60e5e10f8d2e2b0c41e8abad38cacd867caa6ab2Rob Austein# J2EE Agents Bootstrap File
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# OpenAM Policy Agent for:
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# Version: 3.0
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User#------------------------------------------------------------------------------
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# THIS FILE PROVIDES THE CONFIGURATION SETTINGS NECESSARY FOR THE AGENT
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# TO FUNCTION CORRECTLY. PLEASE REFER TO THE DOCUMENTATION BEFORE
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# MODIFYING ANY OF THE VALUES IN THIS FILE.
3ca1a32241189d1e02e59f6b56399eb9b40f2aafTinderbox User# Data present in this file provides the necessary configuration
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# settings needed by Agent to work correctly. Invalid configuration
bfb7b680bf88c1fdd9949197b71c512c532280a4Tinderbox User# data present in this file can lead to malfunction of the Agent, the
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# application, and the Application Server.
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# WARNING: The contents of this file are classified as an UNSTABLE
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# interface by Sun Microsystems, Inc. As such, they are subject to
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# significant, incompatible changes in any future release of the
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User# INVALID CONFIGURATION SETTINGS MAY RESULT IN MALFUNCTION OF THE ENTIRE
0b89eee6167201843c9a46b7e7c63cb1e4e09ba3Tinderbox User#------------------------------------------------------------------------------
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User# NAMING SERVICE URL
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# Specifies the naming service url(s) that can be used by the system
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# for naming lookups. One or more urls can be specified for this
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User# property as a string of urls separated by single space characters.
0da02c26a6631c25f075a8e4ac6de9e58f49a0c2Tinderbox User# Hot-Swap Enabled: No
0da02c26a6631c25f075a8e4ac6de9e58f49a0c2Tinderbox Usercom.iplanet.am.naming.url=@AM_SERVICES_PROTO@://@AM_SERVICES_HOST@:@AM_SERVICES_PORT@@AM_SERVICES_DEPLOY_URI@/namingservice
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User# SERVICE RESOLVER
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User# Specifies the service resolver used by this Agent.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User# Hot-Swap Enabled: No
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Huntcom.sun.identity.agents.config.service.resolver = com.sun.identity.agents.tomcat.v6.AmTomcatAgentServiceResolver
fd2597f75693a2279fdf588bd40dfe2407c42028Tinderbox User# AGENT USERNAME AND PASSWORD PROPERTIES
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# These are the credentials used by the Agent to identify and
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# authenticate itself before requesting any services that require the
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# Agent to be authenticated. If plain text password should not be
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Hunt# used, then supply the encrypted password and encryption key.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User# Hot-Swap Enabled: No
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox Usercom.sun.identity.agents.app.username = @AGENT_PROFILE_NAME@
14a656f94b1fd0ababd84a772228dfa52276ba15Evan Huntcom.iplanet.am.service.secret = @AGENT_ENCRYPTED_PASSWORD@
33c9436ef1a43d3c0fc3d9be9b4b0509daa83223Tinderbox User# The key that will be used to encrypt and decrypt passwords
33c9436ef1a43d3c0fc3d9be9b4b0509daa83223Tinderbox User# Hot-Swap Enabled: No
33c9436ef1a43d3c0fc3d9be9b4b0509daa83223Tinderbox Useram.encryption.pwd = @AGENT_ENCRYPT_KEY@
33c9436ef1a43d3c0fc3d9be9b4b0509daa83223Tinderbox User# DEBUG SERVICE PROPERTIES
363b21045b718d06d414784c96193dc9a233e8c5Tinderbox User# - com.iplanet.services.debug.directory: Specifies the complete path to the
363b21045b718d06d414784c96193dc9a233e8c5Tinderbox User# directory where debug files will be stored by the Agent.
363b21045b718d06d414784c96193dc9a233e8c5Tinderbox User# - com.sun.services.debug.mergeall: consolidates all the debug information
363b21045b718d06d414784c96193dc9a233e8c5Tinderbox User# into one file if it is set to on. Each component has its own debug file
33c9436ef1a43d3c0fc3d9be9b4b0509daa83223Tinderbox User# if it is set to off.
363b21045b718d06d414784c96193dc9a233e8c5Tinderbox User# Hot-Swap Enabled: No
363b21045b718d06d414784c96193dc9a233e8c5Tinderbox Usercom.iplanet.services.debug.directory=@DEBUG_LOGS_DIR@
33c9436ef1a43d3c0fc3d9be9b4b0509daa83223Tinderbox User# AUDIT LOG PROPERTY
33c9436ef1a43d3c0fc3d9be9b4b0509daa83223Tinderbox User# - local.logfile: Specifies the complete path to the local audit log file
33c9436ef1a43d3c0fc3d9be9b4b0509daa83223Tinderbox User# to be used by the Agent.
33c9436ef1a43d3c0fc3d9be9b4b0509daa83223Tinderbox User# Hot-Swap Enabled: No
33c9436ef1a43d3c0fc3d9be9b4b0509daa83223Tinderbox Usercom.sun.identity.agents.config.local.logfile = @AUDIT_LOGS_DIR@/@AUDIT_LOG_FILENAME@
33c9436ef1a43d3c0fc3d9be9b4b0509daa83223Tinderbox User# ORGANIZATION NAME
33c9436ef1a43d3c0fc3d9be9b4b0509daa83223Tinderbox User# Specifies the organization or realm name to be used for authenticating
a1ff871f78b7d907d6fc3a382beea2a640fe8423Tinderbox User# the Agent during runtime. The default value "/" identifies the root
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User# organization or realm.
0da02c26a6631c25f075a8e4ac6de9e58f49a0c2Tinderbox User# Hot-Swap Enabled: No
0da02c26a6631c25f075a8e4ac6de9e58f49a0c2Tinderbox Usercom.sun.identity.agents.config.organization.name = /
8a48b6b9b6fa8486f24b22d1972b2b6ebb36a4a4Tinderbox User# LOCK OF AGENT CONFIGURATION
8a48b6b9b6fa8486f24b22d1972b2b6ebb36a4a4Tinderbox User# When it's set to true, agent config in run-time is locked.
8a48b6b9b6fa8486f24b22d1972b2b6ebb36a4a4Tinderbox User# Agent has to be restarted to let agent config change take effective
8a48b6b9b6fa8486f24b22d1972b2b6ebb36a4a4Tinderbox User# whether the changed config parameter is Hot-Swap or not.
8a48b6b9b6fa8486f24b22d1972b2b6ebb36a4a4Tinderbox User# When it's set to false, change of Hot-Swap agent config parameter can be
8a48b6b9b6fa8486f24b22d1972b2b6ebb36a4a4Tinderbox User# updated into run-time.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User# Hot-Swap Enabled: No
3ca1a32241189d1e02e59f6b56399eb9b40f2aafTinderbox Usercom.sun.identity.agents.config.lock.enable = false
3ca1a32241189d1e02e59f6b56399eb9b40f2aafTinderbox User# AGENT PROFILE NAME
8a48b6b9b6fa8486f24b22d1972b2b6ebb36a4a4Tinderbox User# The profile name used by the Agent to fetch the agent configuration data.
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox User# The value of this property is the same as that of com.sun.identity.agents.app.username
8a48b6b9b6fa8486f24b22d1972b2b6ebb36a4a4Tinderbox User# in most cases. However if multiple agent instances need to use the same credentials
8a48b6b9b6fa8486f24b22d1972b2b6ebb36a4a4Tinderbox User# to authenticate, com.sun.identity.agents.app.username and com.iplanet.am.service.secret
8a48b6b9b6fa8486f24b22d1972b2b6ebb36a4a4Tinderbox User# need to be set to the authenticating credentials accordingly.
8a48b6b9b6fa8486f24b22d1972b2b6ebb36a4a4Tinderbox User# Hot-Swap Enabled: No
7911e6f9de303bca5a3d8b34f4330c8f7cecffaeTinderbox Usercom.sun.identity.agents.config.profilename = @AGENT_PROFILE_NAME@
a1ff871f78b7d907d6fc3a382beea2a640fe8423Tinderbox User# OPENAM DEPLOYMENT URI
3ca1a32241189d1e02e59f6b56399eb9b40f2aafTinderbox User# This property controls the URI under which OpenAM has been deployed. If this
363b21045b718d06d414784c96193dc9a233e8c5Tinderbox User# parameter is not supplied then the default value is /openam.
3ca1a32241189d1e02e59f6b56399eb9b40f2aafTinderbox User# Hot-Swap Enabled: No
363b21045b718d06d414784c96193dc9a233e8c5Tinderbox Usercom.iplanet.am.services.deploymentDescriptor=@AM_SERVICES_DEPLOY_URI@