0a99555401a033704f1f171baab6db11fb5528f2Allan Foster<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk Copyright � 2008 Sun Microsystems, Inc. All rights reserved.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Sun Microsystems, Inc. has intellectual property rights relating to
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster technology embodied in the product that is described in this document.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster In particular, and without limitation, these intellectual property
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster rights may include one or more of the U.S. patents listed at
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster http://www.sun.com/patents and one or more additional patents or pending
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster patent applications in the U.S. and in other countries.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster U.S. Government Rights - Commercial software. Government users are subject
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster to the Sun Microsystems, Inc. standard license agreement and applicable
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster provisions of the FAR and its supplements.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Use is subject to license terms.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster This distribution may include materials developed by third parties.Sun, Sun
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Microsystems, the Sun logo, Java and Solaris are trademarks or registered
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster trademarks of Sun Microsystems, Inc. in the U.S. and other countries. All
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster SPARC trademarks are used under license and are trademarks or registered
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster trademarks of SPARC International, Inc. in the U.S. and other countries.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster UNIX is a registered trademark in the U.S. and other countries, exclusively
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster licensed through X/Open Company, Ltd.
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk Copyright � 2008 Sun Microsystems, Inc. Tous droits r�serv�s.
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk Sun Microsystems, Inc. d�tient les droits de propri�t� intellectuels
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk relatifs � la technologie incorpor�e dans le produit qui est d�crit
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster dans ce document. En particulier, et ce sans limitation, ces droits de
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk propri�t� intellectuelle peuvent inclure un ou plus des brevets am�ricains
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk list�s � l'adresse http://www.sun.com/patents et un ou les brevets
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk suppl�mentaires ou les applications de brevet en attente aux Etats - Unis
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster et dans les autres pays.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster L'utilisation est soumise aux termes du contrat de licence.
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk Cette distribution peut comprendre des composants d�velopp�s par des tierces
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Sun, Sun Microsystems, le logo Sun, Java et Solaris sont des marques de
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk fabrique ou des marques d�pos�es de Sun Microsystems, Inc. aux
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk Etats-Unis et dans d'autres pays. Toutes les marques SPARC sont utilis�es
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk sous licence et sont des marques de fabrique ou des marques d�pos�es de
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster SPARC International, Inc. aux Etats-Unis et dans d'autres pays.
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk UNIX est une marque d�pos�e aux Etats-Unis et dans d'autres pays et
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk licenci�e exlusivement par X/Open Company, Ltd.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster $Id: policy-plugins.html,v 1.2 2009/04/10 22:58:32 mrudul_uchil Exp $
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <META HTTP-EQUIV="CONTENT-TYPE" CONTENT="text/html; charset=iso-8859-1">
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk <TITLE>OpenAM Server - Policy Plugin Samples</TITLE>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <META NAME="GENERATOR" CONTENT="StarOffice 8 (Solaris Sparc)">
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <META NAME="CHANGEDBY" CONTENT="dilli arumugam">
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <META NAME="CHANGED" CONTENT="20080722;14285300">
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <!-- DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Copyright (c) 2008 Sun Microsystems Inc. All Rights Reserved
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster The contents of this file are subject to the terms
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster of the Common Development and Distribution License
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster (the License). You may not use this file except in
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster compliance with the License.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster You can obtain a copy of the License at
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster https://opensso.dev.java.net/public/CDDLv1.0.html or
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster See the License for the specific language governing
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster permission and limitations under the License.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster When distributing Covered Code, include this CDDL
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Header Notice in each file and include the License file
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster If applicable, add the following below the CDDL Header,
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster with the fields enclosed by brackets [] replaced by
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster your own identifying information:
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster "Portions Copyrighted [year] [name of copyright owner]"
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster $Id: policy-plugins.html,v 1.2 2009/04/10 22:58:32 mrudul_uchil Exp $
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster<link rel="stylesheet" type="text/css" href="/com_sun_web_ui/css/css_ns6up.css" />
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster<link rel="shortcut icon" href="/com_sun_web_ui/images/favicon/favicon.ico" type="image/x-icon"></link>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster<div class="SkpMedGry1"><a href="#SkipAnchor2019"><img src="/com_sun_web_ui/images/other/dot.gif" alt="Jump to End of Masthead" border="0" height="1" width="1" /></a></div>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster<table width="100%" border="0" cellpadding="0" cellspacing="0" class="MstTblTop" title="">
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster<table width="100%" border="0" cellpadding="0" cellspacing="0" class="MstTblBot" title="">
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster<div class="MstDivTtl"><img src="/console/images/PrimaryProductName.png" alt="" /></div></td>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster<td class="MstTdLogo" width="1%"><img src="/com_sun_web_ui/images/other/javalogo.gif" alt="Java(TM) Logo" border="0" height="55" width="31" /></td>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster<table class="MstTblEnd" border="0" cellpadding="0" cellspacing="0" width="100%"><tbody><tr><td><img name="RMRealm.mhCommon.EndorserLogo" src="/com_sun_web_ui/images/masthead/masthead-sunname.gif" alt="Sun(TM) Microsystems, Inc." align="right" border="0" height="10" width="108" /></td></tr></tbody></table></div>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster<div class="SkpMedGry1"><a name="SkipAnchor2019" id="SkipAnchor2019"></a></div>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster<div class="SkpMedGry1"><a href="#SkipAnchor4161"><img src="/com_sun_web_ui/images/other/dot.gif" alt="Jump Over Tab Navigation Area. Current Selection is: Access Control" border="0" height="1" width="1" /></a></div>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster<TABLE WIDTH=100% BORDER=0 CELLPADDING=4 CELLSPACING=8 BGCOLOR="#ffffff">
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <H2>How to implement and use custom implementations for Subject,
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Condition, Referral and ResponseProvider interfaces?</H2>
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk <P>OpenAM policy framework defines Subject, Condition, Referral
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster and ResponseProvider interfaces to let developers implement their
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster own plugins to extend the functionality. This sample illustrates
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster the steps involved.</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>Write java source java files implementing Subject,
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Condition, Referral or ResponseProvider interface. See the sample
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster files: <A HREF="/source/com/sun/identity/samples/policy/SampleSubject.java">SampleSubject.java</A>,
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <A HREF="/source/com/sun/identity/samples/policy/SampleCondition.java">SampleCondition.java</A>,
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <A HREF="/source/com/sun/identity/samples/policy/SampleReferral.java">SampleReferral.java</A>,
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <A HREF="/source/com/sun/identity/samples/policy/SampleResponseProvider.java">SampleResponseProvider.java</A></P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>Compile the source files to create class files. You would
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster have to include opensso.jar and opesnsso-sharedlib.jar in
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster classpath at compilation time.</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>Pacakge the compiled classes into jar file, let us call it
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>Add the policy-plugins.jar file to WEB-INF/lib directory.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster You could alernatively copy the custom plugin classes to
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster WEB-INF/classes maintaining directory structure corresponding
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster to the the java package of the plugin classes.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>Update WEB-INF/classes/amPolicy.properties to add l10n
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster values for the new i18n keys used by iPlanetAMPolicyService.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster </P><P>Note : The new i18n keys and their respective values refered here
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster are the ones you would be using in "amPolicy_mod.xml" at step 9.</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>Update WEB-INF/classes/amPolicyConfig.properties to add
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster l10n values for the new i18n keys used by
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster iPlanetAMPolicyConfigService.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster </P><P>Note : The new i18n keys and their respective values refered here
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster are the ones you would be using at step 10.</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>Recreate the war file and redeploy the war file. </P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster through 8 have been already taken care of for the sample
b93185b577f7150fec37f9999b95b246d73bf63cjeff.schenk plugins included in OpenAM distribution.</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>Register the new plugins with iPlanetAMPolicyService using
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster ssoadm command. Assuming password.txt file has
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster the password of amadmin</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <P>ssoadm create-svc -X <amPolicy_mod.xml >-u amadmin -f
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <P>See the sample <A HREF="/source/com/sun/identity/samples/policy/xml/amPolicy_mod.xml">amPolicy_mod.xml</A>.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Notice the new i18keys referred in the xml file. Corresponding
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster l10n values should be added in amPolicy.properties</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>Register the new plugins as choice values in
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster iPlanetAMPolicyConfigService using ssoadm command.</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>ssoadm set-attr-choicevals -s iPlanetAMPolicyConfigService
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster -t Organization -a iplanet-am-policy-selected-subjects -k
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster a160=SampleSubject -u amadmin -f password.txt</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>ssoadm set-attr-choicevals -s iPlanetAMPolicyConfigService
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster -t Organization -a iplanet-am-policy-selected-conditions -k
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster a161=SampleCondition -u amadmin -f password.txt</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>ssoadm set-attr-choicevals -s iPlanetAMPolicyConfigService
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster -t Organization -a iplanet-am-policy-selected-referrals -k
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster a162=SampleReferral -u amadmin -f password.txt</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>ssoadm set-attr-choicevals -s iPlanetAMPolicyConfigService
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster -t Organization -a sun-am-policy-selected-responseproviders
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster -k a163=SampleResponseProvider -u amadmin -f password.txt</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>Optionally register the new plugins as enabled for the
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster selected realm using ssoadm command.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>ssoadm add-attr-defs -s iPlanetAMPolicyConfigService -t
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Organization -a iplanet-am-policy-selected-subjects=SampleSubject
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>ssoadm add-attr-defs -s iPlanetAMPolicyConfigService -t
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Organization -a
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster iplanet-am-policy-selected-conditions=SampleCondition -u amadmin
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>ssoadm add-attr-defs -s iPlanetAMPolicyConfigService -t
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Organization -a
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster iplanet-am-policy-selected-referrals=SampleReferral -u amadmin -f
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>ssoadm add-attr-defs -s iPlanetAMPolicyConfigService -t
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Organization -a
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster sun-am-policy-selected-responseproviders=SampleResponseProvider -u
8bb3e4cda81612f01c0254c263155f65506a018cjeff.schenk <P>You can also use openam console to do the previous setp:
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Login as amadmin or administrator at the realm, navigate to the
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster realm, services, policy configuration and enable or disable the
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster selection of the plugin. You would have to do this step using
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster console for the realms that have been already created.</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>You can now add the instances of the new plugins while
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster defining policies using either console of ssoadm commad. The new
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster plugins would be availabe as choices in right policy management
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster pages in the console.</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster <LI><P>To disable the custom plugins from being added newly to
8bb3e4cda81612f01c0254c263155f65506a018cjeff.schenk policies, using openam console navigate to Access Control >
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Realm > Services | Policy Configuration and deselect the
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster appropriate custom plugins and save the Policy Configuration
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster properties page for exisiting realms. If you navigate to
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Configuration > Global > Policy Configuration and do this,
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster the custom plugins would be deselected for the realms that would
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster be created subsequently.</P>
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster Copy the custom plugin classes to <TOOLS_HOME>/classes
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster maintaining directory structure corresponding
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster to the the java package of the plugin classes.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster You can copy the classes of bundled custom
8bb3e4cda81612f01c0254c263155f65506a018cjeff.schenk sample plugins from explosed openam.war,
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster WEB-INF/classes/com/sun/identity/samples/policy.
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster This is required if you would use ssoadm to export or
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster add policies. </P><P>Note : <TOOLS_HOME> is the ssoadm home directory
0a99555401a033704f1f171baab6db11fb5528f2Allan Foster from where you would be running ssoadm CLI tool.