org.switchyard.policy

Interface Policy

All Known Implementing Classes:

SecurityPolicy, TransactionPolicy

public interface Policy

Base contract for all policy types. Every policy has a string literal representation which is used to identify the policy in application configuration (e.g. "suspendsTransaction").

Author:

Keith Babo © 2011 Red Hat Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Policy.PolicyType policy type.

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Returns the string identifier for the policy.
Policy	getPolicyDependency() Returns a policy which is a dependency of this Policy.
boolean	isCompatibleWith(Policy target) Returns whether the policy passed in parameter is compatible with this or not.
boolean	supports(Policy.PolicyType type) Returns whether the policy type passed in parameter is supported by this policy.

Method Detail

getName

String getName()

Returns the string identifier for the policy.

Returns:

policy name

supports

boolean supports(Policy.PolicyType type)

Returns whether the policy type passed in parameter is supported by this policy.

Parameters:

type - policy type

Returns:

policy type

isCompatibleWith

boolean isCompatibleWith(Policy target)

Returns whether the policy passed in parameter is compatible with this or not.

Parameters:

target - policy to check compatibility

Returns:

true if compatible

getPolicyDependency

Policy getPolicyDependency()

Returns a policy which is a dependency of this Policy.

Returns:

a policy dependency