Skip navigation links

oracle.wsm.policy.util
Class PolicyUtil

java.lang.Object
oracle.wsm.policy.util.PolicyUtil

public class PolicyUtil

extends Object

PolicyUtil contains several utility methods for policy manipulations.

Constructor Summary

PolicyUtil()

Method Summary

static Document	assertionTemplateToDoc(IAssertionTemplate at)
static Document	assertionTemplateToDoc(IAssertionTemplate at, boolean useXDK)
static boolean	checkAttachtoCompatibility(String subjectType, String attachTo) Checks if passed attachTo value policy confirms to the type of subject it is applied to
static List<String>	convertATsToStrs(List<IAssertionTemplate> templates)
static String	convertATToStr(IAssertionTemplate template)
static List<String>	convertPolAttachmentsToStrs(List<IPolicyAttachment> pas)
static String	convertPolAttachmentToStr(IPolicyAttachment pa)
static List<String>	convertPoliciesToStrs(List<IPolicy> pols)
static String	convertPolicySetToStr(IPolicySet polset)
static List<String>	convertPolicySubjectsToStrs(List<IPolicySubject> polSubjects)
static String	convertPolicySubjectToStr(IPolicySubject polSubj)
static String	convertPolicyToStr(IPolicy pol)
static List<String>	convertPolRefsToStrs(List<IPolicyReference> polRefs)
static String	convertPolRefToStr(IPolicyReference polRef)
static List<IAssertionTemplate>	convertStrsToATs(List<String> atsStr, boolean gracefulParse)
static List<IPolicy>	convertStrsToPolicies(List<String> polsStr, boolean gracefulParse)
static List<IPolicyAttachment>	convertStrsToPolicyAttachments(List<String> pasStr)
static List<IPolicySubject>	convertStrsToPolicySubjects(List<String> polSubjsStr)
static List<IPolicyReference>	convertStrsToPolRefs(List<String> polRefsStr)
static IAssertionTemplate	convertStrToAT(String atStr, boolean gracefulParse)
static IPolicy	convertStrToPolicy(String polString, boolean gracefulParse)
static IPolicyAttachment	convertStrToPolicyAttachment(String polAttachment)
static IPolicySet	convertStrToPolicySet(String policySet)
static IPolicySubject	convertStrToPolicySubject(String polSubj)
static IPolicyReference	convertStrToPolRef(String polRef)
static IAssertionTemplate	docToAssertionTemplate(Document document)
static IPolicy	docToPolicy(Document document, boolean parseSlimPolicy)
static IPolicyAttachment	docToPolicyAttachment(Document document)
static List<String>	getAllPossibleAttachToValues() Get a list of all attachTo values that can be expected in the policy attachTo field
static List<ISimpleAssertion>	getAllSimpleAndScenarioAssertions(IPolicy pol) Given a WS-Policy iterates over all Composite Assertions and Nested Assertions and returns the Simple and Scenario Assertions in a WS-Policy.
static IAssertion	getAssertion(List assertionsList, QName qname)
static Set<String>	getAttachToCombinations(String attachtoStr) Given an attachTo value - find all the implied attachTo values The attachTo value has implied semantics - for example: The attachTo value specified the type of Policy Subject.
static List<String>	getBindingAttachtoValues(String actor)
static Set<String>	getIntersectionOfAttachTos(List<String> attachToList)
static List<String>	getPossibleAttachToValues(String bindingActor) Return compatible attachTo values for passed actor type If Actor = null, all possible attachTo values If Actor = server, only binding server compatible values are returned If Actor = client, only binding client compatible values are returned If Actor = component, only generic & component are returned
static List<IAssertion>	getPrimTermsList(IPolicy policy)
static Policy	getSinglePolicy(List policyList, IPolicyRegistry reg)
static boolean	isAndCompositeAssertion(IAssertion assertion)
static boolean	isAuthenticationPolicy(IPolicy pol) Further classifies a Security Policy as being either an Authentication Policy.
static boolean	isAuthzPolicy(IPolicy pol) A policy is considered to be an authorization policy only when following conditions are true: 1.
static boolean	isClientPolicy(IPolicy pol) Given a Policy pol determines if it is a client policy or not.
static boolean	isCompositeAssertion(IAssertion assertion)
static boolean	isManagementPolicy(IPolicy pol) This method validates if the given policy is management policy.
static boolean	isMsgProtectionPolicy(IPolicy pol) Further classifies a Security Policy as being a Message Protection Policy.
static boolean	isMultiElementNestedAssertion(IAssertion assertion)
static boolean	isNestedAssertion(IAssertion assertion)
static boolean	isPolicy(IAssertion assertion)
static boolean	isServicePolicy(IPolicy pol) Given a Policy pol determines if it is a service policy or not.
static boolean	isSimpleAssertion(IAssertion assertion)
static boolean	isXorCompositeAssertion(IAssertion assertion)
static boolean	matchByQName(INestedAssertion primTermA, INestedAssertion primTermB)
static boolean	matchTerms(List<IAssertion> primTermsA, List<IAssertion> primTermsB)
static void	overridePolicyProperties(IPolicy pol, IPolicyReference polRef) Given a PolicyReference that points a Policy and has override properties, over write the value of those properties in the Policy.
static Document	policyAttachmentToDoc(IPolicyAttachment polAttachment, boolean useXDK)
static Document	policyToDoc(IPolicy pol)
static Document	policyToDoc(IPolicy pol, boolean useXDK)
static void	printAssertionClass(IAssertion ia)
static void	printPolicyClass(IPolicy policy)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PolicyUtil

public PolicyUtil()

Method Detail

matchByQName

public static boolean matchByQName(INestedAssertion primTermA,
                                   INestedAssertion primTermB)

isCompositeAssertion

public static boolean isCompositeAssertion(IAssertion assertion)

isNestedAssertion

public static boolean isNestedAssertion(IAssertion assertion)

isXorCompositeAssertion

public static boolean isXorCompositeAssertion(IAssertion assertion)

isAndCompositeAssertion

public static boolean isAndCompositeAssertion(IAssertion assertion)

isPolicy

public static boolean isPolicy(IAssertion assertion)

isSimpleAssertion

public static boolean isSimpleAssertion(IAssertion assertion)

isMultiElementNestedAssertion

public static boolean isMultiElementNestedAssertion(IAssertion assertion)

matchTerms

public static boolean matchTerms(List<IAssertion> primTermsA,
                                 List<IAssertion> primTermsB)

getPrimTermsList

public static List<IAssertion> getPrimTermsList(IPolicy policy)

getSinglePolicy

public static Policy getSinglePolicy(List policyList,
                                     IPolicyRegistry reg)

getAssertion

public static IAssertion getAssertion(List assertionsList,
                                      QName qname)

printPolicyClass

public static void printPolicyClass(IPolicy policy)

printAssertionClass

public static void printAssertionClass(IAssertion ia)

getAllPossibleAttachToValues

public static List<String> getAllPossibleAttachToValues()

Get a list of all attachTo values that can be expected in the policy attachTo field

Returns:

getPossibleAttachToValues

public static List<String> getPossibleAttachToValues(String bindingActor)

Return compatible attachTo values for passed actor type If Actor = null, all possible attachTo values If Actor = server, only binding server compatible values are returned If Actor = client, only binding client compatible values are returned If Actor = component, only generic & component are returned

Parameters:

bindingActor -

Returns:

getAttachToCombinations

public static Set<String> getAttachToCombinations(String attachtoStr)
                                           throws PolicyModelException

Given an attachTo value - find all the implied attachTo values The attachTo value has implied semantics - for example: The attachTo value specified the type of Policy Subject. A Policy with a particular attachTo value can be attached to only Policy Subjects of that type. For example: if attachTo is binding.server.soap - then the Policy can be attached to only Server side Policy Subjects that have soap binding. if attachTo is binding.any.soap - then the Policy can be attached to either a Server side or Client Side Policy Subjects that have soap bindings. Thus if the attachTo is binding.server.soap this "implies" that all Policies who attachTo is binding.any.soap are also applicable.

Parameters:

attachtoQuery -

Returns:

Throws:

PolicyModelException

getBindingAttachtoValues

public static List<String> getBindingAttachtoValues(String actor)

getIntersectionOfAttachTos

public static Set<String> getIntersectionOfAttachTos(List<String> attachToList)
                                              throws PolicyModelException

Throws:

PolicyModelException

isAuthzPolicy

public static boolean isAuthzPolicy(IPolicy pol)
                             throws PolicyModelException

A policy is considered to be an authorization policy only when following conditions are true: 1. A policy has only one assertion. 2. The assertion is of type SimpleAssertion or ScenarioAssertion 3. The assertion has category of security/authorization

Parameters:

pol -

Returns:

Throws:

PollicyModelException

PolicyModelException

isAuthenticationPolicy

public static boolean isAuthenticationPolicy(IPolicy pol)
                                      throws PolicyModelException

Further classifies a Security Policy as being either an Authentication Policy. A policy is considered to be an authentication policy only when following conditions are true: 1. The policy category is "security". Also a policy has to have atleast one assertion. 2. The assertion has category of security/authn

Parameters:

pol -

Returns:

Throws:

PolicyModelException

isManagementPolicy

public static boolean isManagementPolicy(IPolicy pol)
                                  throws PolicyModelException

This method validates if the given policy is management policy.

Parameters:

pol - the policy file

Returns:

Throws:

PolicyModelException

isMsgProtectionPolicy

public static boolean isMsgProtectionPolicy(IPolicy pol)
                                     throws PolicyModelException

Further classifies a Security Policy as being a Message Protection Policy. A policy is considered to be a message protection policy only when following conditions are true: 1. The policy category is "security". Also a policy has to have atleast one assertion. 2. The assertion has category of security/msg-protection

Parameters:

pol -

Returns:

Throws:

PolicyModelException

getAllSimpleAndScenarioAssertions

public static List<ISimpleAssertion> getAllSimpleAndScenarioAssertions(IPolicy pol)
                                                                throws PolicyModelException

Given a WS-Policy iterates over all Composite Assertions and Nested Assertions and returns the Simple and Scenario Assertions in a WS-Policy.

Parameters:

pol -

Returns:

List<ISimpleAssertion> the list of Simple or Scenario Assertions in the Policy

Throws:

PolicyModelException - - if it encounteres an unknown assertion type

checkAttachtoCompatibility

public static boolean checkAttachtoCompatibility(String subjectType,
                                                 String attachTo)

Checks if passed attachTo value policy confirms to the type of subject it is applied to

Parameters:

subjectType - The subject type

attachTo - The attachTo value of the a policy

Returns:

true if the the attachTo value is compatible to the subject Type

docToPolicy

public static IPolicy docToPolicy(Document document,
                                  boolean parseSlimPolicy)
                           throws PolicyModelException

Throws:

PolicyModelException

policyToDoc

public static Document policyToDoc(IPolicy pol)
                            throws PolicyModelException

Throws:

PolicyModelException

policyToDoc

public static Document policyToDoc(IPolicy pol,
                                   boolean useXDK)
                            throws PolicyModelException

Throws:

PolicyModelException

docToAssertionTemplate

public static IAssertionTemplate docToAssertionTemplate(Document document)
                                                 throws PolicyModelException

Throws:

PolicyModelException

assertionTemplateToDoc

public static Document assertionTemplateToDoc(IAssertionTemplate at)
                                       throws PolicyModelException

Throws:

PolicyModelException

assertionTemplateToDoc

public static Document assertionTemplateToDoc(IAssertionTemplate at,
                                              boolean useXDK)
                                       throws PolicyModelException

Throws:

PolicyModelException

docToPolicyAttachment

public static IPolicyAttachment docToPolicyAttachment(Document document)
                                               throws PolicyModelException

Throws:

PolicyModelException

policyAttachmentToDoc

public static Document policyAttachmentToDoc(IPolicyAttachment polAttachment,
                                             boolean useXDK)
                                      throws PolicyModelException

Throws:

PolicyModelException

isClientPolicy

public static boolean isClientPolicy(IPolicy pol)

Given a Policy pol determines if it is a client policy or not. This is determied by looking at the the orawsp:attachTo attribute

Parameters:

pol -

Returns:

true - if it is a client policy or false it it is not

isServicePolicy

public static boolean isServicePolicy(IPolicy pol)

Given a Policy pol determines if it is a service policy or not. This is determied by looking at the the orawsp:attachTo attribute

Parameters:

pol -

Returns:

true - if it is a service policy or false it it is not

convertPolicyToStr

public static String convertPolicyToStr(IPolicy pol)
                                 throws PolicySerializationFailedException

Throws:

PolicySerializationFailedException

convertPoliciesToStrs

public static List<String> convertPoliciesToStrs(List<IPolicy> pols)
                                          throws PolicySerializationFailedException

Throws:

PolicySerializationFailedException

convertPolicySetToStr

public static String convertPolicySetToStr(IPolicySet polset)
                                    throws PolicySerializationFailedException

Throws:

PolicySerializationFailedException

convertStrToPolicy

public static IPolicy convertStrToPolicy(String polString,
                                         boolean gracefulParse)
                                  throws PolicyParseFailedException

Throws:

PolicyParseFailedException

convertStrToPolicySet

public static IPolicySet convertStrToPolicySet(String policySet)
                                        throws PolicyParseFailedException

Throws:

PolicyParseFailedException

convertStrsToPolicies

public static List<IPolicy> convertStrsToPolicies(List<String> polsStr,
                                                  boolean gracefulParse)
                                           throws PolicyParseFailedException

Throws:

PolicyParseFailedException

convertATToStr

public static String convertATToStr(IAssertionTemplate template)
                             throws PolicySerializationFailedException

Throws:

PolicySerializationFailedException

convertATsToStrs

public static List<String> convertATsToStrs(List<IAssertionTemplate> templates)
                                     throws PolicySerializationFailedException

Throws:

PolicySerializationFailedException

convertStrToAT

public static IAssertionTemplate convertStrToAT(String atStr,
                                                boolean gracefulParse)
                                         throws PolicyParseFailedException

Throws:

PolicyParseFailedException

convertStrsToATs

public static List<IAssertionTemplate> convertStrsToATs(List<String> atsStr,
                                                        boolean gracefulParse)
                                                 throws PolicyParseFailedException

Throws:

PolicyParseFailedException

convertPolRefToStr

public static String convertPolRefToStr(IPolicyReference polRef)
                                 throws PolicySerializationFailedException

Throws:

PolicySerializationFailedException

convertPolRefsToStrs

public static List<String> convertPolRefsToStrs(List<IPolicyReference> polRefs)
                                         throws PolicySerializationFailedException

Throws:

PolicySerializationFailedException

convertStrToPolRef

public static IPolicyReference convertStrToPolRef(String polRef)
                                           throws PolicyParseFailedException

Throws:

PolicyParseFailedException

convertStrsToPolRefs

public static List<IPolicyReference> convertStrsToPolRefs(List<String> polRefsStr)
                                                   throws PolicyParseFailedException

Throws:

PolicyParseFailedException

convertPolAttachmentsToStrs

public static List<String> convertPolAttachmentsToStrs(List<IPolicyAttachment> pas)
                                                throws PolicySerializationFailedException

Throws:

PolicySerializationFailedException

convertPolAttachmentToStr

public static String convertPolAttachmentToStr(IPolicyAttachment pa)
                                        throws PolicySerializationFailedException

Throws:

PolicySerializationFailedException

convertStrToPolicyAttachment

public static IPolicyAttachment convertStrToPolicyAttachment(String polAttachment)
                                                      throws PolicyParseFailedException

Throws:

PolicyParseFailedException

convertStrsToPolicyAttachments

public static List<IPolicyAttachment> convertStrsToPolicyAttachments(List<String> pasStr)
                                                              throws PolicyParseFailedException

Throws:

PolicyParseFailedException

convertStrToPolicySubject

public static IPolicySubject convertStrToPolicySubject(String polSubj)
                                                throws PolicyParseFailedException

Throws:

PolicyParseFailedException

convertStrsToPolicySubjects

public static List<IPolicySubject> convertStrsToPolicySubjects(List<String> polSubjsStr)
                                                        throws PolicyParseFailedException

Throws:

PolicyParseFailedException

convertPolicySubjectToStr

public static String convertPolicySubjectToStr(IPolicySubject polSubj)
                                        throws PolicySerializationFailedException

Throws:

PolicySerializationFailedException

convertPolicySubjectsToStrs

public static List<String> convertPolicySubjectsToStrs(List<IPolicySubject> polSubjects)
                                                throws PolicySerializationFailedException

Throws:

PolicySerializationFailedException

overridePolicyProperties

public static void overridePolicyProperties(IPolicy pol,
                                            IPolicyReference polRef)
                                     throws PolicyModelException

Given a PolicyReference that points a Policy and has override properties, over write the value of those properties in the Policy.

Parameters:

pol -

polRef -

Throws:

PolicyModelException

Skip navigation links