CA eTrust SiteMinder Developer's Guide for Java

More documents

Recommendations

Info

Java API FlowIf you do not already have a default connection but you want a user-definedconnection object, you can use the Agent API to create the agent object andthen create the new connection, as follows:1. Create the agent object.You can create an agent object based on connection parameters fromeither of the following sources:■User-defined connection parameters defined in your code—forexample: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 accountingPortcan all be set to the same value.■Connection parameters stored in an Agent configuration file(WebAgent.conf or LocalConfig.conf). For example, the following codeestablishes a connection on a Netscape server:AgentAPI agent = new AgentAPI();InitDef init = new InitDef();agent.getConfig(init, "myagent","/opt/netscape/server4/https-smdev/config/WebAgent.conf");agent.init(init);Note: An Agent configuration file for a v5QMRx or v6.x agent containsdifferent information than an Agent configuration file for a v4QMRx agent.20 Developer's Guide for Java
Java API Flow2. Create the new connection.After creating the agent object, you create the new connection in either ofthese ways:■Pass the agent object you just created into the constructor of the newSmApiConnection object—for example:SmApiConnection myConnection = new SmApiConnection(agent);■Call setAgentApiConnection() and pass in the agent object you justcreated—for example:SmApiConnection myConnection=new SmApiConnection(false,false);myConnection.setAgentApiConnection(agent);If you establish the connection in this way, the Java Agent API handle willbe a user-defined handle.If you call setAgentApiConnection() but you do not have a connection, youcan establish an automatic, static connection by passing in null.Obtain a SessionAfter obtaining a connection to the Policy Server, you need to obtain a user oradministrator session. (To use the Policy Management API, you must connectas a SiteMinder Administrator. The SiteMinder Policy Server validates a user’srights to perform an operation.)When you obtain a session object, you pass it to the Policy Management API orthe DMS API through the constructor for the SmPolicyApiImpl class or theSmDmsApiImpl class.To obtain a session, perform one of these actions:If... And... Then...You have an existingsession fromauthenticating a user.— Pass in the sessionspecification for theauthenticated user.You don’t have anexisting session.You don’t have anexisting session.You must connect as aSiteMinderAdministrator.You want to connect asa non-Administrator.Use the methodSmApiSession.login().Use the Java Agent API toobtain a sessionspecification for the user.Note: To use the Policy Management API, you must connect as a SiteMinderAdministrator.Chapter 1: Java API Overview 21
Page 2 and 3: This documentation and any related
Page 5 and 6: ContentsChapter 1: Java API Overvie
Page 7 and 8: Make Policy Management API Requests
Page 9: Set Search Parameters When You Crea
Page 12 and 13: Code SamplesCode SamplesThe SiteMin
Page 14 and 15: Policy Management APIThe SiteMinder
Page 16 and 17: How Java Components Fit TogetherHow
Page 18 and 19: Java API FlowThere are two types of
Page 22 and 23: Java API FlowYou might already have
Page 24 and 25: Javadoc ReferenceJavadoc ReferenceT
Page 26 and 27: Connection ClassConnection ClassYou
Page 28 and 29: Result ClassInterpret a Result Obje
Page 30 and 31: Property ClassThe core methods of t
Page 32 and 33: Agent API Class HierarchyThe Agent
Page 34 and 35: Implement the Pure Java Agent API5.
Page 36 and 37: Connection to a Policy Server■■
Page 38 and 39: User Access to Resources5. Audit ca
Page 40 and 41: Java Agent API ServicesJava Agent A
Page 42 and 43: Authorization ServicesSession Termi
Page 44 and 45: Tunnel ServicesTunnel ServicesTunne
Page 46 and 47: Single Sign-on4. Custom agent creat
Page 48 and 49: Server ClustersAdvantages of Sessio
Page 50 and 51: Server ClustersCluster failover occ
Page 52 and 53: Agent TypeAgent TypeThe Agent Type
Page 54 and 55: About Policy ManagementAbout Policy
Page 56 and 57: Policy Store Objects■■■■■
Page 58 and 59: Write a Policy Management Applicati
Page 60 and 61: Agent Configuration Object MethodsA
Page 62 and 63: General Object MethodsMethoddeleteD
Page 64 and 65: ODBC Query Scheme MethodsODBC Query
Page 66 and 67: Realm MethodsMethoddoImport()Descri
Page 68 and 69: Self-Registration MethodsSelf-Regis
Page 70 and 71:
Utility MethodsMethodgetUserPolicie
Page 72 and 73:
Retrieve Objects from the Policy St
Page 74 and 75:
Authentication Scheme Configuration
Page 76 and 77:
Page 79 and 80:
Page 81:
individuals might increase their in
Page 84 and 85:
Page 86 and 87:
Page 88 and 89:
Page 90 and 91:
Page 92 and 93:
Page 94 and 95:
Page 96 and 97:
Page 98 and 99:
Page 100 and 101:
Page 102 and 103:
Page 104 and 105:
Page 106 and 107:
Page 108 and 109:
Page 110 and 111:
Page 113 and 114:
Chapter 5: Authentication andAuthor
Page 115 and 116:
Shared InformationShared Informatio
Page 117 and 118:
Create a Custom Authentication Sche
Page 119 and 120:
Page 121 and 122:
Page 123 and 124:
Page 125 and 126:
Page 127 and 128:
Use the Authorization API8. After t
Page 129 and 130:
Use the Authorization APIInterpret
Page 131 and 132:
Use the Authorization APIOther Clas
Page 133 and 134:
Use the Authorization APIActive Rul
Page 135 and 136:
Use the Authorization APITo modify
Page 137:
Use the Authorization API■■To e
Page 140 and 141:
The Required JAR File■■Adding a
Page 142 and 143:
Attribute-based DelegationAttribute
Page 144 and 145:
Implementation Class■SiteMinder a
Page 146 and 147:
Search ClassThe objects correspondi
Page 148 and 149:
Write a Directory Management Applic
Page 150 and 151:
Page 152 and 153:
Page 154 and 155:
Page 156 and 157:
Page 158 and 159:
SearchesSet Search Parameters When
Page 160 and 161:
SearchesSet the Search FilterThe se
Page 162 and 163:
SearchesSearch an OrganizationIn th
Page 164 and 165:
User Password StateThe following co
Page 166 and 167:
Restricted Methods■■SmDmsUser.a
Page 168 and 169:
Restricted MethodsMethodsearchForwa
Page 170 and 171:
Authentication Scheme Dialog • 11
Page 172 and 173:
getDmsContext() • 144, 166getDmsD
Page 174 and 175:
organizations in flat directories
Page 176 and 177:
SmApiResult class • 27SmApiSessio
show all

CA eTrust SiteMinder Developer's Guide for Java

Create successful ePaper yourself

Delete template?

Save as template?