Thursday Sep 11, 2008

GlassFish Instructions: domain1 for OpenSSO, domain2 for Policy Agent

This blog entry explains how to install GlassFish to host both OpenSSO server and Policy Agent 3.0. I then get into a little about deploying the agent sample application. In the very next blog entry, I get into configuring and experimenting with the sample application.

This one entry includes various tasks. The deployment described involves two GlassFish domains: one for OpenSSO (between builds 5 and 6) and one for the GlassFish agent (Agent for Application Server 9.0). The instructions are all for a Solaris 10 SPARC machine.

I've covered some of this before in this blog. However, I was using older OpenSSO builds. Some instruction details have changed since then. Furthermore, the use of two domains on GlassFish is new. Also, the sample application details included in the next blog entry are new.

NOTE TO READER: If you see anything that isn't clear or is outright incorrect, don't hesitate to leave a comment. I'll try to straighten it out.

To Install GlassFish

This task description explains how to install GlassFish as an eventual container for OpenSSO server and Policy Agent 3.0.  This is all being performed on on a Solaris 10 SPARC machine. The objective is to deploy OpenSSO on GlassFish domain1. Then to create a second glassfish domain (domain2) and install Policy Agent 3.0 (Agent for Application Server 9.0).
  1. Set the JAVA_HOME or JRE_HOME variable.
    For my environment (using the Bourne shell a.k.a "sh" shell), I did the following:
    1. Issue the following command:
      # JAVA_HOME=/usr/jdk/instances/jdk1.5.0
    2. Issue the following command:
      # export JAVA_HOME
    3. Issue the following commnad:
      # env
      This allows you to ensure that the JRE_HOME variable is set in the list of environment variables.

  2. Make a directory for the GlassFish installation.
    For example, in the root directory:
    # mkdir GF_OSSO_PA
    That's my shorthand for GlassFish container for OpenSSO server and the Glassfish agent.

  3. Using a browser, download glassfish-installer-v2ur2-b04-sunos.jar to the GlassFish installation directory you just created. As you know, I named it as follows: /GF_OSSO_PA

    I downloaded the GlassFish build listed above. I got to that file and one will see other similar GlassFish builds by starting here:
    https://glassfish.dev.java.net/public/downloadsindex.html
    Which brought me here:
    https://glassfish.dev.java.net/downloads/v2ur2-b04.html
    This is the wording and such for the download I finally got:
    Solaris SPARC Platform
    glassfish-installer-v2ur2-b04-sunos.jar, size 54M

    You can navigate to the download or you can right click the link immediately above and choose the option that controls where the download is saved within your directory system.

  4. Using the command line, extract the file using: 
    # java -Xmx256m -jar
    glassfish-installer-v2ur2-b04-sunos.jar
    A license agreements appears.

  5. Accept the agreement
    1. Scroll and read through the agreement.
    2. Click Accept.
    This creates a glassfish directory with everything inside.

  6. Change into the glassfish directory. For example:
    # cd /GF_OSSO_PA/glassfish

  7. Run the two following commands: 
    • # chmod -R +x lib/ant/bin
    • # lib/ant/bin/ant -f setup.xml

  8. After a successful build, change to the glassfish/bin directory. For example:
    # cd
    /GF_OSSO_PA/glassfish/bin

  9. Issue the command to start domain1:
    For example, I issued the following command:

    ./asadmin start-domain domain1

  10. Using a browser, verify the server is running by accessing http://OpenSSOhost.example.com:8080.
    You should get a Server Running page.

    I'm referring to this host,  which is using domain1, as OpenSSOhost because it will host the OpenSSO server.

  11. Using a browser, login to domain1 of GlassFish as admin (PW: adminadmin) by accessing the console using a browser:
    An example of the URL is as follows: http://OpenSSOhost.example.com:4848.

    Notice that 4848 is the port for the console for domain1 of Glassfish. The console for other domains will have different port numbers.

  12. Edit the domain.xml file of domain1 as described in the substeps that follow:

    When Glassfish is the container for the OpenSSO server, the domain.xml file should be edited as described.

    1. Change directories to the config directory of domain1.
      For example:
      # cd /GF_OSSO_PA/glassfish/domains/domain1/config

    2. Using your text editor of choice, open the domain.xml file.

    3. Change the following JVM options as shown in the table below:

      Changes to Make
      Lines Before Editing
      Lines After Editing
      "client" to "server"
      <jvm-options>-client</jvm-options> <jvm-options>-server</jvm-options>
      "512 to "1024"
      <jvm-options>-Xmx512m</jvm-options>
      <jvm-options>-Xmx1024m</jvm-options>

To Create a Second GlassFish Domain

These instructions are necessary if you are going to install OpenSSO and the GlassFish agent on the same Glassfish server. You cannot install the two on the same domain, so you will need to create a second GlassFish domain.

  1. Ensure that domain1 is running.

    You can do this by ensuring that GlassFish is accessible in a browser.
    For my scenario, I visited the follwing URL: http://OpenSSOhost.example.com:8080

    With domain1 running, you ensure that domain2 won't be assigned the same port as domain1.

  2. Issue the command to create domain2:
    For example, I issued the following command:

    # /GF_OSSO_PA/glassfish/bin/asadmin create-domain --adminport 6868 --user admin domain2

    Notice that the port 6868 used in the command above is the port to use to log in to GlassFish server domain2 while port 4848 is the port to use to log in to GlasFish server domain1.

  3. Enter adminadmin as the password for the various password prompts you receive.

    After you provide all the passwords, a list of configuration information is displayed.

  4. Note the port number for the HTTP instance.

    You will need this port number when you create Agent for Application Server 9.0 (the Glassfish agent) Look for the line about the HTTP instance. For example:
    Default port 8080 for HTTP Instance is in use. Using 33053
    In such a case you would note 33053. You will need that port number (whatever, it might be) when you install the agent on domain2.

  5. Start the second GlassFish domain:
    For example, I issued the following command:

    # /GF_OSSO_PA/glassfish/bin/asadmin start-domain domain2

  6. Enter adminadmin as the password for the password prompt you receive.

  7. Using a browser, verify that you have access to the GlassFish console for domain2 by logging in to domain2 using admin (PW: adminadmin):

    An example of the URL is as follows: http://OpenSSOhost.example.com:6868.

  8. Shutdown the second GlassFish domain:
    For example, I issued the following command:

    # /GF_OSSO_PA/glassfish/bin/asadmin stop-domain domain2

    If you don't shutdown the second domain before creating the agent (later on), it will modify files.

  9. Shutdown the first GlassFish domain:
    For example, I issued the following command:

    # /GF_OSSO_PA/glassfish/bin/asadmin stop-domain domain1

To Install OpenSSO on GlassFish Domain1

These instructions involve downloading OpenSSO in the same directory where I downloaded GlassFish (GF_OSSO_PA). I use domain1 of the GlassFish server.
  1. Change directories to the location you want to download the OpenSSO binaries.

    I used the GF_OSSO_PA directory I created previously. For example, I issued the following command:
    # cd /GF_OSSO_PA

  2. Using a browser, download the OpenSSO binaries to the directory of your choice.
    For my scenario, I downloaded the binaries to the following directory: GF_OSSO_PA

    The general URL to start from is as follows:

    https://opensso.dev.java.net/public/use/index.html

    A more specific location on the above page, for periodic builds, is here:
    https://opensso.dev.java.net/public/use/index.html#periodic

    The above URL brings you to the table named Periodic OpenSSO and Client SDK Builds. You could navigate to that table and right click the "opensso.zip" link. Or you could just right click it here: "opensso.zip". Then  you can choose the option that controls where the download is saved within your directory system.

    At the time I performed this task, the latest build was September 10th. When I install the GlassFish agent (described later in this blog entry), I also use the September 10th build. 

    Be aware that there's a risk-reward relationship involved with using periodic builds. The reward is that you might be able to see the newest features and behaviors. The risk is that the chances of the build failing or acting oddly are greater than when you use a stable buld. At least, you know the September 10th build is stable enough to handle all the tasks described in this blog entry.

    If you want to install the same build that I did (since you know it's relatively stable) but at a point in time in which the Sept 10th build is no longer available from the Periodic OpenSSO and Client SDK Builds table, then you can pick it up at this link: http://download.java.net/general/opensso/nightly/20080910.1/opensso/

    You can go to that page and right click the openso.zip link or you can right click it here: opensso.zip. Then you can control which directory the file is downloaded to.

  3. Unzip the opensso.zip file.
    I used the following command:
    # unzip opensso.zip

    This creates an opensso directory. Therefore, for me the opensso directory was at the following location: /GF_OSSO_PA/opensso

  4. Copy the opensso.war file from the distributed opensso files to the autodeploy directory of the GlassFish server domain1.
    For example:
    cp /GF_OSSO_PA/opensso/deployable-war/opensso.war /GF_OSSO_PA/glassfish/domains/domain1/autodeploy

    A few ways exist to deploy the opensso.war file. The command above demonstrates the method I used.

  5. Start domain1 of the GlassFish server.
    For Example, I issued the following command:

    # /GF_OSSO_PA/glassfish/bin/asadmin start-domain domain1

    Starting GlassFish domain1 with the opensso.war file in the autodeploy directory deploys the opensso.war file.

  6. Confirm that GlassFish domain1 has started and OpenSSO has deployed as described in the substeps that follow:

    1. Use a browser to check that Glassfish domain 1 has started:
      For example, in a browser window, go to the following location:
      http://OpenSSOhost.example.com:8080/

      If everything goes properly, you will see the message:
      "Your Application Server is now running"

    2. Add the string opensso to the URL in the browser window.
      For example:
      http://OpenSSOhost.example.com:8080/opensso

      If everything goes properly, you will see the OpenSSO server page labeled Configuration Options.

  7. Proceed with the configuration as described in the substeps that follow:
    You don't need to go with the default configuration, but that's what I did.

    1. Click Create Default Configuration.

    2. Enter the same password for both of the Default User Fields: Password and Confirm.
      For example, admin123.

      By the way, the password you enter here is used by you and other administrators to log into OpenSSO. At that Login page (which comes up when you visit http://OpenSSOhost.example.com:8080/opensso), the value to enter for the User Name field is amAdmin while the password is the one you are creating in this substep.

    3. Enter the same password for both of the Default Agent Fields: Password and Confirm.
      For example, agent123.
      Ensure that this password is different from the one you just created in the step above.
      You might not ever need this password again. One situation you would need it is if you install Policy Agent 2.2 with this OpenSSO deployment. In that situation, this password would be needed. In that case, it is used in conjunction with the user name "UrlAccessAgent."

    4. Click OK.

      The configuration process continues for a couple of minutes and then shows a configuration complete message.

    5. Click  Proceed to Login.
      This brings you to the login page, which is at a URL such as the following:
      http://OpenSSOhost.example.com:8080/opensso/UI/Login

  8. Log in using the proper credentials.
    For example:
    User Name: amAdmin
    Password: admin123

To Create an Agent Password File

The location of this file is required and will be prompted for by the agent installer.
  1. Create an ACSII text file for the agent profile. The following is an example
    of such a text file: /GF_OSSO_PA/gfagentpw

    I combined steps one and two by creating the file (gfagentpw) and adding the password (agent456) in a single command as follows:

    # echo agent456>>/GF_OSSO_PA/gfagentpw

  2. (CONDITIONAL) If you didn't combine the creation of text and the creation of the file in one command, using a text editor, enter the appropriate pasword in clear text on the first line of the file.

  3. Secure the  password file appropriately, depending on the requirements of your deployment.

To Create the Agent Profile in the OpenSSO Console

When I create the agent, I won't choose the option for the agent installer to create the agent profile for me automatically (agentadmin --custom-isntall), so I need to do this task myself.
  1. Using a browser, log in to OpenSSO Console as amAdmin.
    For example:
    http://OpenssoHost.example.com:8080/opensso
  2. Select Access Control tab>realmname (such as Top Level Realm)>Agents>J2EE
  3. In the Agent section, click New.
  4. Fill in the fields as appropriate:

    Field
    Example Value
    Name
    glassfishagent
    Password
    agent456
    Re-enter Password
    agent456
    Configuration
    Centralized
    Server URL http://OpenssoHost.example.com:8080/opensso
    Agent URL
    http://AgentHost.example.com:33053/agentapp
About the fields: Note the name and password you enter since you will need this info again. The password must be the same as the password in the agent password file (for example agent456). A centralized configuration is a key aspect to Policy Agent 3.0 and allows you to control the agent from the OpenSSO Console. For the Server URL, enter the info for the OpenSSO server. In this case, I'm using GlassFish domain 1. For the Agent URL, enter the info for the GlassFish server that you just installed with the port number for domain2, which for my scenario was port 33053 as explained in the task described previously in this entry titled "To Create a Second GlassFish Domain."

To Install the GlassFish Agent on GlassFish Domain2

This task involves the installation of the GlassFish agent on the GlassFish server, domain2.
  1. Download the Sun Java System Application Server 9 (the GlassFish) agent to the directory in which you want to uninstall the agent.

    For my situation, I'm downloading the agent in to the following directory: /GF_OSSO_PA

    Since I used the September 10 build for the OpenSSO download, I'll be using the same date for the GlassFish agent download. If you install the OpenSSO server and the agent on the same day, the "latest" directory for the two downloads will have the same date.

    You can start form the following URL for the latest J2EE agent builds:
    http://download.java.net/general/opensso/nightly/latest/j2eeagents/

    If you want to go to that page, you can then right click the link "appserver_v9_agent_3.zip" in the table or you can right click the following link: appserver_v9_agent_3.zip. Then you can choose the option that controls where the download is saved within your directory ststem.

    If you want to install the same build that I did but at a point in time in which the Sept 10th build is no longer available from the J2EE agent page listed above, then you can pick it up at this link: http://download.java.net/general/opensso/nightly/20080910.1/j2eeagents/

    You can go to that page and right click the appserver_v9_agent_3.zip link or you can right click the following link: "appserver_v9_agent_3.zip." Then you can choose the option that controls which directory the file is downloaded to.

  2. Unzip the zip file.
    For example:
    # unzip appserver_v9_agent_3.zip

  3. (Conditional) Ensure that GlassFish domain1 is running.
    During agent installation, the agent searches for the OpenSSO server. The installation is more complete if the OpenSSO server is running.

    For example, you can check the GlassFish console (http://OpenssoHost.example.com:4848). If it is not accessible, start GlassFish domain1 (For example # /GF_OSSO_PA/glassfish/bin/asadmin start-domain domain1)

  4. Change to the directory that contains the agentadmin utility. For example:
    # cd /GF_OSSO_PA/
    j2ee_agents/appserver_v9_agent/bin

  5. Set the permissions for the agentadmin utility. For example:
    # chmod 755 agentadmin

  6. Start the agent installation. For example:
    # ./agentadmin --install

    I used ./agentadmin --install instead of ./agentadmin --custom-install.

  7. Complete the installation as described in the substeps that follow:
    1. Continually press enter to accept the various parts of the license agreement.

    2. Enter yes to accept the complete agreement.
      You must then answer the agent installer prompts. Many of your responses will be responsses you provided when you created the agent profile.

    3. Respond to the following prompt:
      Enter the Application Server Config Directory Path
      [/opt/SUNWappserver/domains/domain1/config]:

      I responded with the following:
      /GF_OSSO_PA/glassfish/domains/domain2/config

    4. Respond to the following prompt:
      OpenSSO server URL:

      I responded with the name of the GlassFish Server domain1, which is where I installed OpenSSO:
      http://OpenssoHost.example.com:8080/opensso

      I've messed up here before where I put a forward slash "/" after "opensso": That causes huge problems. Don't put anything after "opensso": not even a space.

    5. Respond to the following prompt:
      Agent URL:

      I responded with the name of the GlassFish instance including the port for domain2:
      http://AgentHost.example.com:33053/agentapp

    6. Respond to the following prompt:
      Enter the Agent Profile name:

      I responded with the following:
      glassfishagent

    7. Respond to the following prompt:
      Enter the path to the password file:

      I responded with the following:
      /GF_OSSO_PA/gfagentpw

      Then, a summary of your responses is displayed as such:

      Verify your settings above and decide from the choices below.
      1. Continue with Installation
      2. Back to the last interaction
      3. Start Over
      4. Exit
      Please make your selection [1]:

    8. Choose the applicable option.

      I responded by pressing Return to accept the default choice: "1. Continue with Installation"

To Deploy Applications on GlassFish

There are a few ways to deploy applications on GlassFish. This task shows the method I used. I deployed two applications at the same time. The agentapp.war file is used for housekeeping tasks, and it required for the notification mechanism to function. The agentsample.ear file is the J2EE agent sample application, which gives you the opportunity to practice protecting an application with the agent. Therefore, you can create policies and perform other tasks that control access to the application and then you can test those policies.  I'll be configuring the sample application in the next task, so I decided to deploy it at the same time that I'm deploying the agent application.

Deploying the sample application (e.g agentsample.ear)  the way I do below (without building my own sample application)  is possible because the agentsample.ear file is already built for me with the assumption that I  used the default realm, "opensso" when installing the OpenSSO server.  Well, good, I really did use the "opensso" realm, so I didn't have to change the realm information and rebuild the sample application myself. By the way, such details are explained in the sample application readme.txt file:
(e.g. /GF_OSSO_PA/j2ee_agents/appserver_v9_agent/sampleapp/readme.txt)

  1. Copy the agentapp.war file and the agentsample.ear file to the GlassFish domain2 autodeploy directory. For example, from the root directory, I issued the following commands:

    # cp /GF_OSSO_PA/j2ee_agents/appserver_v9_agent/etc/agentapp.war /GF_OSSO_PA/glassfish/domains/domain2/autodeploy

    # cp /GF_OSSO_PA/j2ee_agents/appserver_v9_agent/sampleapp/dist/agentsample.ear  /GF_OSSO_PA/glassfish/domains/domain2/autodeployGlassfish Console: Left Pane

  2. Start GlassFish domain2 (the domain on which the agent is installed) with the appropriate command. For example I issued the following command:
    # /GF_OSSO_PA/glassfish/bin/asadmin start-domain domain2

  3. Enter the master password.
    For example:
    adminadmin

    When the domain starts, the two applications will deploy.

  4. Verify that the Application Server is running and the two applications were deployed as described in the substeps that follow:

    1. Using a browser, access http://GlassFishHost.example.com:6868

      Remember that because of the way I created domain2, port 6868 is the correct port for domain2.

    2. Log in with the proper credentials. For example:
      User name: admin
      Password: adminadmin

  5. In the left pane, click the arrows next to the following labels:
    • Enterprise Applications
    • Web Applications

    You should see the two applications you just deployed, the agentsample and the agentapp, as illustrated in the image to the right.

    Now things are set for you to experiment with the sample application,

    Sean Brydon has written up quite a bit about the J2EE sample applicaton, the quick example is here and the detailed example is here.
The very next blog entry (Policy Agent 3.0: Learning About J2EE Agents By Using the Sample Application) describes how to set up the sample application. It's real important and useful info. Really!!!

Wednesday Jul 23, 2008

Policy Agent 3.0 Ease of Use

When it comes to OpenSSO, the idea of Centralized Agents is a big deal. That's one of the ease-of-use features that's coming with OpenSSO. There have been a lot of little niceties made along the way that make the centralization of the agents even easier for customers. As the OpenSSO builds continue, configuring the agents in the OpenSSO Console has become simpler (step by step) for customers.

If you have installed earlier builds along the way, you've seen some of the improvements. I have included a couple of screenshots of the OpenSSO Console, showing the Policy Agent property views. These properties are map constructs. A map property is a property where a value is mapped to a key. In earlier builds, you had to enter more complicated information in a field. Now, the more complicated stuff is handled behind the scenes. You just enter a map key in one field and it's value in the other.

Hopefully, the inline help gives you enough information to understand what to enter for the map key and value. The inline help has become more thorough also, build by build.

Furthermore, if you need more detailed info then is available in Help, you'll be able to find it as I continue to work on the Policy Agent 3.0 Properties wiki. For example, the J2EE agent property listed below, Agent Filter Mode, is pretty involved. However, there's a description on the wiki for it now: http://wikis.sun.com/display/OpenSSO/j2eeagentfiltermode

Such descriptions are a work in progress. They can be continually improved upon as various deployment scenarios bring up new questions about a property.

A Web Agent Map Property

A snapshot of a web agent map property

A J2EE Agent Map Property

A snapshot of a J2EE map property

The Agent Filter Mode property above is interesting because it highlights the global option, which applies to some J2EE map properties. Some J2EE map properties can apply to specific applications on the application server or globally to all the applications on the application server. The inline instructions above describe how to apply the property globally to all applications or individually to specific applications.

Tuesday Jul 15, 2008

OpenSSO Policy Agent Properties: What do you want to know?

Policy Agent 3.0 is coming out soon enough and the properties are still complicated. You can set them in the Federated Access Manager Console now, which is good, but it's still complicated. It's the details that are difficult to get. And yet, some times you just gotta have the details.

What Do You Want to Know About Agent Properties?

What would you like to see in terms of property descriptions? Yes, YOU! Please tell us what you need to know, what you want to know.

The property details need to be filled in, so let us know which properties you would like described. We might as well start providing details for properties that the community wants. More on this later (see Questions)

Goal of the Policy Agent 3.0 Wiki

Let me exaplain. In an effort to capture all the details that come in for Policy Agent properties starting with Policy Agent 3.0, I'm putting together the following wiki page:

Policy Agent 3.0 Property Page

I'm just getting this Policy Agent 3.0 properties wiki put together now. However, if you perform an Internet search (using Google or whatever) by a specific Policy Agent property name, the search results will probably include this wiki (and relatively high in the results, too) as such: "agent3properties - OpenSSO - wikis.sun.com." This wiki should soon become THE place to go for reference info on Policy Agent 3.0 properties.

Policy Agent developer, Sean Brydon, has been instrumental in getting this wiki going. The problem in the past has been that even when a property description seems clear, which they often are not, other details can come in later  about how the property interacts with other agent properties, or how certain settings affect how the agent interacts with Federated Access Manager, or a myriad of other details.

Clearly, it would be best if the property descriptions could be living descriptions that can be updated by a variety of stakeholders, especially those right in there working with the properties. That is the type of structure I hope to provide with the agent property wiki.

This Wiki and Federated Access Manager Console: The Connection

By following the link to the  Policy Agent 3.0 Property Page, you'll notice that the wiki lays out the Policy Agent 3.0 properties in the same manner they are presented in the Federated Access Manager Console. Below is a snapshot of the Console, specifically showing a view of a J2EE agent. The snapshot shows the first few J2EE agent properties in the Global tab. Those first few properties are all in the Profile category:

This is an image of the Federated Access Manager Console in a J2EE agent view



The table that follows shows how the Policy Agent wiki lists the properties in the following category (Notice that the Details links in the table are live):

J2EE agent > Global > Profile

Profile (Global J2EE agent properties)

Property Label Property Name Online Help More Details
Group N/A Help Details
Password N/A Help Details
Password (confirm) N/A Help Details
Status N/A Help Details
Agent Notification URL com.sun.identity.client.notification.url Help Details
Location of Agent Configuration Repository N/A Help Details
Configuration Reload Interval com.sun.identity.agents.config.load.interval Help Details
Agent Configuration Change Notification com.sun.identity.agents.config.change.notification.enable Help Details

The table that follows shows how the Policy Agent wiki lists the properties in the following category (Notice that the Details links in the table are live):

Web agent > Global > Profile

Profile (Global web agent properties)

Property Label Property Name Online Help More Details
Group N/A Help Details
Password N/A Help Details
Password (confirm) N/A Help Details
Status N/A Help Details
Location of Agent Configuration Repository N/A Help Details
Agent Configuration Change Notification com.sun.identity.agents.config.change.notification.enable Help Details
Enable Notifcations com.sun.identity.agents.config.notification.enable Help Details
Agent Notifcation URL com.sun.identity.client.notification.url Help Details
Agent Deploymet URI Prefix com.sun.identity.agents.config.agenturi.prefix Help Details
Configuration Reload Interval com.sun.identity.agents.config.polling.interval Help Details
Configuration Cleanup Interval com.sun.identity.agents.config.cleanup.interval Help Details

The Details Links

I'd like to get comments from the OpenSSO community on the property descriptions. At this point, in the  Policy Agent 3.0 wiki,  not too many of the Details links are filled in. However, for both web agents and J2EE agents, I've filled in all the properties in the Profile category. In the properties wiki, you have to click the Details link and look at each property description one by one. That will probably suit folks who are looking up info on a specific property.

Since I'd like to get community feedback on the property descriptions, I've listed the properties for the Profile category in the table below, so you can see them all in one shot. I've copied the descriptions exactly as they are in the Details links and pasted them in the table. However, since the properties in the Profile category don't align perfectly between web agents and J2EE agents, I've moved the J2EE properties around slightly in the table, so they now align.

Here are some questions to consider when you look at the property descriptions and when you look at the Policy Agent properties wiki in general:

  • Which of the properties in the table below have descriptions that you think are lacking?
  • What type of info do you want for a given property?
  • Do you have a better suggestion for a property description?
  • Besides the Profile properties, which other properties would you like to see descriptions for first?
  • Do you have any comments about the structure and such of the Policy Agent Properties Wiki Page?:
    http://wikis.sun.com/display/OpenSSO/agent3properties
  • Do you have any comments on the structure of the Details pages?
If you have any comments please leave them in this blog entry.

Web Agents
 J2EE Agent

Property Label:
Group
Property Name:
N/A
Description: The "group" property is available starting with Sun Federated Access Manager Policy Agent 3.0.

The property allows you to assign an individual web agent to a previously configured web agent group. The individual web agent can then inherit selected properties from the group.

Property Label:
Group
Property Name:
N/A
Description: The "group" property is available starting with Sun Federated Access Manager Policy Agent 3.0.

The property allows you to assign an individual J2EE agent to a previously configured J2EE agent group. The individual J2EE agent can then inherit selected properties from the group.
Property Label:
Password
Property Name:
N/A
Description: The value for the "Password" property was set when the agent was created using the Federated Access Manager Console or the famadm utility.

It was also the password that was in the agent profile password file when the agentadmin program was issued to install the agent. You can change the password at any time in the future.
Property Label:
Password
Property Name:
N/A
Description: The value for the "Password" property was set when the agent was created using the Federated Access Manager Console or the famadm utility.

It was also the password that was in the agent profile password file when the agentadmin program was issued to install the agent. You can change the password at any time in the future.
Property Label:
Password (confirm)
Property Name:
N/A
Description: The value for the "Password(confirm)" property must match the "Password" property. If you change the "Password" property you must also change the "Password(confirm)" property.
Property Label:
Password (confirm)
Property Name:
N/A
Description: The value for the "Password(confirm)" property must match the "Password" property. If you change the "Password" property you must also change the "Password(confirm)" property.
Property Label:
Status
Property Name:
N/A
Description: This property is set to Active by default. When set to Active, the agent is able to authenticate to and communicate with Federated Access Manager. When set to Inactive, the agent is not able to authenticate to Federated Access Manager.
Property Label:
Status
Property Name:
N/A
Description: This property is set to Active by default. When set to Active, the agent is able to authenticate to and communicate with Federated Access Manager. When set to Inactive, the agent is not able to authenticate to Federated Access Manager.
Property Label:
Location of Agent Configuration Repository
Property Name:
N/A
Description:

The value for this property is originally set when the agent profile is created. If desired, change the configuration location to whichever of the two options is available: centralized or local. The centralized location allows you to control the configuration in a centralized manner, such as from the Console.

The local option is provided for backward compatibility purposes. If the local configuration option is selected, the agent will use its local configuration in the FAMAgentConfiguration.properites file in the agent installation directory.

In addition, the Console will only display the following properties: Password , Password (confirmation) , and Status
Property Label:
Location of Agent Configuration Repository
Property Name:
N/A
Description:

The value for this property is originally set when the agent profile is created. If desired, change the configuration location to whichever of the two options is available: centralized or local. The centralized location allows you to control the configuration in a centralized manner, such as from the Console.

The local option is provided for backward compatibility purposes. If the local configuration option is selected, the agent will use its local configuration in the FAMAgentConfiguration.properites file in the agent installation directory.

In addition, the Console will only display the following properties: Password , Password (confirmation) , and Status

Property Label:
Agent Configuration Change Notification
Property Name:
com.sun.identity.agents.config.change.notification.enable
Description: When this property is enabled, the agent receives notification messages from the Federated Access Manager server about configuration changes.
Property Label:
Agent Configuration Change Notification
Property Name:
com.sun.identity.agents.config.change.notification.enable
Description: When this property is enabled, the agent receives notification messages from the Federated Access Manager server about configuration changes.
Property Label:
Enable Notifcations
Property Name:
com.sun.identity.agents.config.notification.enable
Description: When this property is enabled, notifications help maintain the following agent caches: SSO, policy, and configuration.
N/A
Property Label:
Agent Notifcation URL
Property Name:
com.sun.identity.client.notification.url
Description: The value for this property is the URL used by the agent to register notification listeners.
Property Label:
Agent Notification URL
Property Name:
com.sun.identity.client.notification.url
Description: The value for this property is the URL used by the agent to register notification listeners.
Property Label:
Agent Deploymet URI Prefix
Property Name:
com.sun.identity.agents.config.agenturi.prefix
Description: The value for this property is the value of the Universal Resource Identifier (URI). The default value is /amagent.
N/A
Property Label:
Configuration Reload Interval
Property Name:
com.sun.identity.agents.config.polling.interval
Description: The value for this property is the interval in minutes to fetch the agent configuration from Federated Access Manager.
Property Label:
Configuration Reload Interval
Property Name:
com.sun.identity.agents.config.load.interval
Description: The value for this property is the interval in seconds between configuration reloads. Setting this property to 0 disables the hot-swap mechanism.
Property Label:
Configuration Cleanup Interval
Property Name:
com.sun.identity.agents.config.cleanup.interval
Description: The value for this property is the interval in minutes to cleanup old agent configuration entries.
N/A

Summary

That sums things up. If you ever have any questions about a property, ask me here. I'll try to get the answer, and if applicable, I'll add the information to the Policy Agent 3.0 properties wiki.

About

What does this box do?

Search

Archives
« April 2014
SunMonTueWedThuFriSat
  
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
   
       
Today