3-18 Developers Guide for Oracle Access Manager and Oracle Security Token Service
These JAR files are located in the following path: DOMAIN_HOME
serversMANAGED_INSTANCE_NAMEtmp_WL_useroam_serverRANDOM_STRING APP-INFlib
3.5 Adding Custom Plug-ins
This section provides the following topics:
■
About Managing Custom Plug-ins
■
Adding Custom Plug-ins
■
Deleting Custom Authentication Plug-ins
3.5.1 About Managing Custom Plug-ins
Custom authentication plug-ins can be created and used in custom authentication modules, and, in turn, used in authentication schemes.
After development, the plug-in must be deployed on the admin server, as a JAR file, which is validated automatically. After validation, an administrator can configure and
distribute the plug-in using the Oracle Access Suite.
The server processes the XML configuration file within the plug-in JAR file to extract data about the plug-in. After the plug-in is imported, an administrator can see and
modify the various plug-in states based on information available from the AdminServer.
Figure 3–14 illustrates the Plug-ins Node under the Common Configuration section of
the System Configuration tab, and the Plugins page. This page includes a tool bar with command buttons, most of which operate on the plug-in that is selected in the table.
The table provides information about the existing custom plug-ins and their state. The Plugin Details section at the bottom of the page reflects configuration details for the
selected plug-in the table.
Creating Custom Authentication Plug-ins 3-19
Figure 3–14 Plug-ins Node Under Common Configuration and the Plugins Page
Administrators control plug-in states using the command buttons across the table at the top of the Plugins page, as described in
Table 3–4 .
3-20 Developers Guide for Oracle Access Manager and Oracle Security Token Service
Table 3–4 Managing Custom Plug-ins Actions
Action Description
Import Plugin... Adds the plug-in JAR file to the AdminServer DOMAIN_HOMEoamplugins and
begins plug-in validation.
■
Same JAR Name : If the new plug-in JAR name in DOMAIN_
HOMEoamplugins matches an existing plug-in JAR name in DOMAIN_ HOMEconfigfmwconfigoamplugins, Oracle Access Manager extracts new
configuration metadata from the XML file in the JAR in DOMAIN_ HOMEoamplugins and checks the version of the new plug-in.
■
XML Version : If the new plug-in XML version in DOMAIN_
HOMEoamplugins is greater than the existing XML version in DOMAIN_ HOMEconfigfmwconfigoamplugins, validation is successful. Otherwise,
invalid plugin name with invalid version is returned and the new plug-in JAR is removed from DOMAIN_HOMEoamplugins.
■
Different JAR Name : If the new plug-in JAR name in DOMAIN_
HOMEoamplugins is different then existing plug-in JAR names in DOMAIN_ HOMEconfigfmwconfigoamplugins, the new plug-in JAR is uploaded and
validation is successful.
On Success : Status is reported as Uploaded even if an OAM Server is down. If all
registered OAM Servers report Uploaded, then the status on AdminServer is also Uploaded.
On Failure : Status is reported as Upload Failed
See Also: About the Custom Plug-in Life Cycle in the Oracle Fusion Middleware Developers Guide for Oracle Access Manager and Oracle Security Token Service
Distribute Selected ...
■
Propagates the plug-in to all registered OAM Servers.
■
Sets the plug-in flag in oam-config.xml to Distribute=true.
■
Starts the distribution listener and notification mechanism between AdminServer and OAM Servers
■
Distributes the plug-in JAR from AdminServer node to each OAM Server node under DOMAIN_HOMEconfigfmwconfigoamplugins
On Success : Status is reported as Distributed even if an OAM Server is down. If all
registered OAM Servers report Distributed, then the status on AdminServer is also Distributed.
On Failure : Status is reported as Distribution Failed
