com.soa.policy.config

Interface PolicyManager

public interface PolicyManager

The PolicyManager is an interface for managing policy configuration.

Since:

6.0

Method Summary

Modifier and Type	Method and Description
javax.xml.transform.Source	getPolicyConfiguration(java.lang.String policyKey) Retrieve policy configuration with policy key
javax.xml.transform.Source	getPolicyConfiguration(java.lang.String policyKey, int version) Retrieve policy version configuration with policy key, and version
java.lang.String	getPolicyKey(Policy policy) Match existing policy against the Policy model by either policy name or policy id.
boolean	updateAllowed(PolicyKey policyKey) Checks if current user is allowed to update policy.
void	updatePolicyConfiguration(PolicyKey policyKey, javax.xml.transform.Source policyConfiguration) Save policy configuration for a policy key.

Method Detail

updatePolicyConfiguration

void updatePolicyConfiguration(PolicyKey policyKey,
                               javax.xml.transform.Source policyConfiguration)
                        throws GException

Save policy configuration for a policy key. Policy configuration must have a policy element wrapper.

Parameters:

policyKey -

policyConfiguration -

Throws:

GException

getPolicyConfiguration

javax.xml.transform.Source getPolicyConfiguration(java.lang.String policyKey)
                                           throws GException

Retrieve policy configuration with policy key

Parameters:

policyKey - policy key

Returns:

Source is an XML source containing policy configuration

Throws:

GException

getPolicyConfiguration

javax.xml.transform.Source getPolicyConfiguration(java.lang.String policyKey,
                                                  int version)
                                           throws GException

Retrieve policy version configuration with policy key, and version

Parameters:

policyKey - policy key

version - version

Returns:

Source is an XML source containing policy configuration

Throws:

GException

getPolicyKey

java.lang.String getPolicyKey(Policy policy)
                       throws GException

Match existing policy against the Policy model by either policy name or policy id. If policy name is specified, use policy name to match, otherwise, if policy id is specified, use policy id to match. If both policy name and policy id are specified, only policy name is used to match.

Parameters:

policy - model

Returns:

policy key which represents existing policy matched, otherwise return null

Throws:

GException

updateAllowed

boolean updateAllowed(PolicyKey policyKey)
               throws GException

Checks if current user is allowed to update policy.

Parameters:

policyKey -

Returns:

true if current user allowed to update policy, false otherwise

Throws:

GException