CA eTrust SiteMinder Developer's Guide for Java

More documents

Recommendations

Info

Connection ClassConnection ClassYou use the SmApiConnection class to create an API connection object andestablish a connection between the Agent API and Policy Server. Dependingupon the constructor you use, you can establish either a default connection ora user-defined connection.The core methods of the SmApiConnection class are as follows:MethodgetAgentApiConnection()isValidApiConnection()setAgentApiConnection()DescriptionRetrieves the Agent API handle for thecurrent connection. Use this handle whenissuing subsequent Java API requests tothe Policy Server.Verifies whether a valid Agent APIconnection is available.Establishes a user-defined connectionthrough the handle passed into themethod. If null is passed, a staticconnection is established.Note: Do not call the execute() method from your client application. Thismethod is for internal use only.Session ClassThe Session class, SmApiSession, lets you create a session object by passingin a valid API connection and, depending upon the constructor you use, asession specification. (A session specification is also known as a sessionticket).The core methods of the SmApiSession class are as follows:MethodgetApiConnection()getSessionSpec()login()DescriptionRetrieves the SmApiConnection object forthe current connection.Retrieves the specification for the currentsession.Logs in a SiteMinder administrator. ThePolicy Server issues a session specificationfor the session.26 Developer's Guide for Java
Result ClassMethodlogout()setApiConnection()setSessionSpec()DescriptionLogs out a SiteMinder administrator.Sets a valid API connection.Sets an existing session specification.Note: For login and logout of end users, DMS organization administrators,and DMS super administrators, use the AgentAPI.login() and AgentAPI.logout()methods in the Agent API package.Result ClassThe Result class, SmApiResult, stores the result of a SiteMinder Java APIrequest. A SiteMinder result contains the following elements:■■■■Facility. Origin of the result. For example, the result might originate on theclient or server.Severity. Significance of the result, such as informational or warning.Status. Status code of the result. Status codes are unique within eachfacility. You can use a facility’s unique status code to distinguish aparticular result from other results that might have originated from thefacility.Message. Additional information about the result, such as descriptive textor numeric details.A result might also include a reason code. For example, a password policyresult might include a reason code of 1001, meaning that the password doesnot contain the required minimum number of characters. To find a reason codefor a result, call getReason().All server-side errors are returned as results, not as exceptions. However,when a client-side exception is thrown, an SmApiResult object is embedded inthe exception.Chapter 2: Utilities Package 27
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 20 and 21: Java API FlowIf you do not already
Page 22 and 23: Java API FlowYou might already have
Page 24 and 25: Javadoc ReferenceJavadoc ReferenceT
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:
Authentication Scheme Configuration
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

You also want an ePaper? Increase the reach of your titles

Delete template?

Save as template?