Scripting and Programming Guides › Developer's Guide for Java › Java API Overview › Java API Flow › Establish a Connection to the Policy Server › Establish a User-Defined Connection to the Policy Server

Establish a User-Defined Connection to the Policy Server

You establish a user-defined connection in one of two ways:

• By referencing an existing Java Agent API connection handle in the constructor of the SmApiConnection object.
• By establishing a new connection manually through the setAgentApiConnection() method.

Note: If you already have a connection to the Policy Server, you can use it to make subsequent Policy Management API or DMS API calls.

To create a connection using an existing Agent API connection

1. Create your connection object through the following constructor:

      SmApiConnection (netegrity.siteminder.javaagent.AgentAPI
                                                 agentApiConnection)
   

2. In the constructor, use agentApiConnection to pass in the handle of the existing Agent API connection—for example:

      SmApiConnection myConnection = 
                         new SmApiConnection (myAgentApiConnection);
   

   The new Java Agent API handle is a user-defined handle.

If you do not already have a default connection and you want a user-defined connection object, you can use the Agent API to create the agent object and then create the new connection, as follows:

1. Create the agent object.

   You can create an agent object based on connection parameters from either of the following sources:

   • User-defined connection parameters defined in your code—for example:

     AgentAPI agent = new AgentAPI();
     ServerDef sd = new ServerDef();
     sd.serverIpAddress = POLICY_IP;
     sd.connectionMin = CX_MIN;
     sd.connectionMax = CX_MAX;
     sd.connectionStep = CX_STEP;
     sd.timeout = CX_TIMEOUT;
     sd.authorizationPort = AZ_PORT;
     sd.authenticationPort = AUTH_PORT;
     sd.accountingPort = ACC_PORT;
     InitDef init=new InitDef(AGENT_LOGIN,SHARED_SECRET,false, sd);
     agent.init(init);
     

   Note: With SiteMinder v6.0 and later, the authorization, authentication, and accounting servers are combined into a single server process. Consequently, authorizationPort, authenticationPort, and accountingPort can all be set to the same value.

   • Connection parameters stored in an Agent configuration file.

   Note: SiteMider v4.x webagent.conf files are no longer supported by the SM API.

2. Create the new connection.

   After creating the agent object, you create the new connection in either of these ways:

   • Pass the agent object you just created into the constructor of the new SmApiConnection object—for example:

     SmApiConnection myConnection = new SmApiConnection(agent);
     

   • Call setAgentApiConnection() and pass in the agent object you just created—for example:

     SmApiConnection myConnection=new SmApiConnection(false,false);
     myConnection.setAgentApiConnection(agent);
     

   If you establish the connection in this way, the Java Agent API handle is a user-defined handle.

   If you call setAgentApiConnection() and you do not have a connection, you can establish an automatic, static connection by passing in null.