2
Introduction to the Access SDK and API 2-1
2
Introduction to the Access SDK and API
This chapter provides the following sections:
■
Section 2.1, Introduction to the Access SDK
■
Section 2.2, Locating Access SDK Packages and Resources
■
Section 2.3, Uses, Functionality, and New Features
■
Section 2.4, Messages, Exceptions and Logging
■
Section 2.5, Configuring and Deploying Access Clients
■
Section 2.6, Developing Access Clients
■
Section 2.7, Building and Deploying an Access Client Program
■
Section 2.8, Compatibility: 11g versus 10g Access SDK and APIs
■
Section 2.9, Migrating Earlier Applications or Converting Your Code
■
Section 2.10, Best Practices
2.1 Introduction to the Access SDK
The Oracle Access Manager 11g Access SDK is a platform independent package that Oracle has certified on a variety of enterprise platforms using both 32-bit and 64-bit
modes and hardware combinations. It is provided on JDK versions that are supported across Oracle Fusion Middleware applications.
The oracle.security.am.asdk package provides the Oracle Access Manager 11g version of the Application Programming Interface API. The 11g version is very
similar to the Oracle Access Manager 10g API, with enhancements for use with the OAM 11g Server. The 11g Access SDK provides backwards compatibility by
supporting com.oblix.access interfaces.
The Oracle Access Manager 10g 10.1.4.3 com.oblix.access package and classes are deprecated. A deprecated API is not recommended for use, generally due to
improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
See Also: Oracle Security Token Service Java API Reference
Note: Oracle strongly recommends that developers use the Oracle
Access Manager 11g Access SDK for all new development.
2-2 Developers Guide for Oracle Access Manager and Oracle Security Token Service
2.2 Locating Access SDK Packages and Resources
Once the Access SDK is installed, do not change the relative locations of the subdirectories and files. Doing so may prevent an accurate build and proper operation
of the API.
Table 2–1 identifies the Access SDK packages and resources and where you can find
each one.
2.3 Uses, Functionality, and New Features
The Oracle Access Manager 11g Access SDK is intended for Java application developers and the development of tightly coupled, performant integrations.
From a functional perspective, the Oracle Access Manager 11g Access SDK maintains parity with the 10g 10.1.4.3 Java Access SDK to ensure that you can re-write existing
custom code using the new API layer.
The Oracle Access Manager 11g Access SDK includes authentication and authorization functionality. However, it does not include Administrative APIs for instance, there is
no 11g Policy Manager API and does not use Oracle Access Manager 11g cookies.
The most common use of the Access SDK is to enable the development of a custom integration between Oracle Access Manager and other applications Oracle or third
party. Usage examples include:
Table 2–1 Locations: Access SDK Resources
Resources and Locations Supported Versions and Platforms
: Oracle Technology Network http:www.oracle.comtechnetworkmiddlewareiasdownloadsfusion-cert
ification-100350.html
Download Packages : Oracle Technology Network
http:www.oracle.comtechnetworkmiddlewaredownloadsoid-11g-161194. html
Oracle Access Manager 11g Access SDK Packages:
■
oracle.security.am.asdk : A new authentication and authorization API that provides
enhancements to take advantage of Oracle Access Manager 11g Server functionality. The Oracle Access Manager 11g version of the Access SDK API can be used with either Oracle
Access Manager 10gR3 10.1.4.3 or Oracle Access Manager 11gR1 11.1.1.5+ version of the Server.
■
com.oblix.access : Available for compatibility with programs written with an Oracle
Access Manager 10g JNI ASDK, this is the 10g version of the authentication and authorization API with some enhancements for Oracle Access Manager 11g.
Java Docs :
■
Oracle Access Manager Access SDK Java API Reference
■
Oracle Access Manager Extensibility Java API Reference
■
Oracle Security Token Service Java API Reference Each method includes the following details:
■
Comprehensive description of a method
■
Parameters of the method
■
Return values
■
Exceptions the method may throw
■
Other relevant details
