com.guardtime.ksi.unisignature.verifier.policies

Class ContextAwarePolicyAdapter

java.lang.Object

com.guardtime.ksi.unisignature.verifier.policies.ContextAwarePolicyAdapter

All Implemented Interfaces:

ContextAwarePolicy, Policy

public class ContextAwarePolicyAdapter
extends Object
implements ContextAwarePolicy

Method Summary

Modifier and Type	Method and Description
static ContextAwarePolicy	createCalendarPolicy(Extender extender) Creates context aware policy using CalendarBasedVerificationPolicy for verification.
static ContextAwarePolicy	createDefaultPolicy(PublicationsHandler handler, Extender extender) Creates context aware policy using DefaultVerificationPolicy for verification.
static ContextAwarePolicy	createInternalPolicy() Creates context aware policy using InternalVerificationPolicy for verification.
static ContextAwarePolicy	createKeyPolicy(PublicationsHandler handler) Creates context aware policy using KeyBasedVerificationPolicy for verification.
static ContextAwarePolicy	createPolicy(Policy policy, PublicationsHandler handler, KSIExtendingService extendingService) Method creating context aware policy using user provided policy with needed components.
static ContextAwarePolicy	createPublicationsFilePolicy(PublicationsHandler handler) Creates context aware policy using PublicationsFileBasedVerificationPolicy for verification.
static ContextAwarePolicy	createPublicationsFilePolicy(PublicationsHandler handler, Extender extender) Creates context aware policy using PublicationsFileBasedVerificationPolicy for verification.
static ContextAwarePolicy	createUserProvidedPublicationPolicy(PublicationData publicationData) Creates context aware policy using UserProvidedPublicationBasedVerificationPolicy for verification.
static ContextAwarePolicy	createUserProvidedPublicationPolicy(PublicationData publicationData, Extender extender) Creates context aware policy using UserProvidedPublicationBasedVerificationPolicy for verification.
Policy	getFallbackPolicy() Used to get the fallback policy set by Policy.setFallbackPolicy(Policy).
String	getName() Human readable name of the policy
PolicyContext	getPolicyContext() Returns the context of the policy
List<Rule>	getRules() Used to get the rules of the policy.
String	getType() This method returns the type of the policy.
void	setFallbackPolicy(Policy fallbackPolicy) Sets a fallback policy to be used when signature does not verify with given policy.

Methods inherited from class java.lang.Object

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

Method Detail

createInternalPolicy

public static ContextAwarePolicy createInternalPolicy()

Creates context aware policy using InternalVerificationPolicy for verification.

Returns:

Internal verification policy with suitable context.

createKeyPolicy

public static ContextAwarePolicy createKeyPolicy(PublicationsHandler handler)

Creates context aware policy using KeyBasedVerificationPolicy for verification.

Parameters:

handler - Publications handler.

Returns:

Key based verification policy with suitable context.

createPublicationsFilePolicy

public static ContextAwarePolicy createPublicationsFilePolicy(PublicationsHandler handler)

Creates context aware policy using PublicationsFileBasedVerificationPolicy for verification.

Parameters:

handler - Publications handler.

Returns:

Publications file based verification policy with suitable context.

createPublicationsFilePolicy

public static ContextAwarePolicy createPublicationsFilePolicy(PublicationsHandler handler,
                                                              Extender extender)

Creates context aware policy using PublicationsFileBasedVerificationPolicy for verification. If extender is provided, then extending is allowed while verifying signature.

Parameters:

handler - Publications handler.

extender - Extender.

Returns:

Publications file based verification policy with suitable context.

createCalendarPolicy

public static ContextAwarePolicy createCalendarPolicy(Extender extender)

Creates context aware policy using CalendarBasedVerificationPolicy for verification. Since extender is provided, then extending is allowed when verifying signature.

Parameters:

extender - Extender.

Returns:

Calendar based verification policy with suitable context.

createUserProvidedPublicationPolicy

public static ContextAwarePolicy createUserProvidedPublicationPolicy(PublicationData publicationData)

Creates context aware policy using UserProvidedPublicationBasedVerificationPolicy for verification. Only user provided publication data is used for verification.

Parameters:

publicationData - User provided publication data.

Returns:

User provided publication based verification policy with suitable context.

createUserProvidedPublicationPolicy

public static ContextAwarePolicy createUserProvidedPublicationPolicy(PublicationData publicationData,
                                                                     Extender extender)

Creates context aware policy using UserProvidedPublicationBasedVerificationPolicy for verification. If extender is set, signature is extended within verification process.

Parameters:

publicationData - User provided publication data.

extender - Extender.

Returns:

User provided publication based verification policy with suitable context.

createDefaultPolicy

public static ContextAwarePolicy createDefaultPolicy(PublicationsHandler handler,
                                                     Extender extender)

Creates context aware policy using DefaultVerificationPolicy for verification. If extender is set, signature is extended within verification process.

Parameters:

handler - Publications handler.

extender - Extender.

Returns:

Context aware verification policy for default verification.

createPolicy

public static ContextAwarePolicy createPolicy(Policy policy,
                                              PublicationsHandler handler,
                                              KSIExtendingService extendingService)

Method creating context aware policy using user provided policy with needed components.

Parameters:

policy - Policy.

handler - Publications handler.

extendingService - Extender client.

Returns:

Policy with suitable context.

getPolicyContext

public PolicyContext getPolicyContext()

Description copied from interface: ContextAwarePolicy

Returns the context of the policy

Specified by:

getPolicyContext in interface ContextAwarePolicy

getRules

public List<Rule> getRules()

Description copied from interface: Policy

Used to get the rules of the policy. The rules are used to verify KSI signature.

Specified by:

getRules in interface Policy

Returns:

list of rules to be used to verify KSI signature

getName

public String getName()

Description copied from interface: Policy

Human readable name of the policy

Specified by:

getName in interface Policy

Returns:

the name of the policy

getType

public String getType()

Description copied from interface: Policy

This method returns the type of the policy.

Specified by:

getType in interface Policy

getFallbackPolicy

public Policy getFallbackPolicy()

Description copied from interface: Policy

Used to get the fallback policy set by Policy.setFallbackPolicy(Policy).

Specified by:

getFallbackPolicy in interface Policy

Returns:

instance of Policy if fallback policy is set.

setFallbackPolicy

public void setFallbackPolicy(Policy fallbackPolicy)

Sets a fallback policy to be used when signature does not verify with given policy.

Specified by:

setFallbackPolicy in interface Policy

Parameters:

fallbackPolicy - the fallback policy used when signature does not verify with given policy. All fallback policies in he chain must be instances of ContextAwarePolicy.