issrg.pba
Interface AuthzTokenParser

All Known Subinterfaces:

RoleBasedAuthzTokenParser

All Known Implementing Classes:

MultiAuthzTokenParser, RoleBasedACParser, SAMLAATokenParser, ShibbolethAuthzTokenParser, SimplePERMISTokenParser, VOMSSAMLAATokenParser, XMLAuthTokenParser

public interface AuthzTokenParser

This interface defines the method needed for extracting the known Credentials from Authorisation Tokens. It should not be aware of delegation, it simply extracts the purported set of credentials. The correct allocation of credentials by the issuer is checked by the Allocation Policy.

Version:

1.2

Author:

A Otenko

Method Summary

ParsedToken	decode(java.lang.Object at) This method decodes the Authorisation Token into internal representation.
java.util.Map	getAuthzTokenParsingRules() This method returns the Auth Token parsing rules currently used by the parser.
SignatureVerifier	getSignatureVerifier() This method gets the Signature Verifier used by the Token Parser.
void	setAuthzTokenParsingRules(java.util.Map rules) This method sets the Auth Token parsing rules.
void	setSignatureVerifier(SignatureVerifier signatureVerifier) This method sets the Signature Verifier to be used by the Token Parser.

Method Detail

decode

ParsedToken decode(java.lang.Object at)
                   throws PbaException

This method decodes the Authorisation Token into internal representation. The rest of the methods can be used to retrieve data from this token. Note that in the case that it is a malformed AuthorisationToken or is not the expected Authorisation Token, an exception will be thrown.

Parameters:

at - - implementation-specific object returned by the Repository; it is the authorisation token to be decoded

Returns:

ParsedToken - implementation-independent representation of the Authorization token

Throws:

PbaException - if any error occurs; for example, the given object is not a proper Authorisation Token that the implementation can handle

getAuthzTokenParsingRules

java.util.Map getAuthzTokenParsingRules()

This method returns the Auth Token parsing rules currently used by the parser.

setAuthzTokenParsingRules

void setAuthzTokenParsingRules(java.util.Map rules)

This method sets the Auth Token parsing rules.

setSignatureVerifier

void setSignatureVerifier(SignatureVerifier signatureVerifier)

This method sets the Signature Verifier to be used by the Token Parser. Token Parsers for tokens that do not have signatures may ignore this method call.

getSignatureVerifier

SignatureVerifier getSignatureVerifier()

This method gets the Signature Verifier used by the Token Parser. Token Parsers for tokens that do not have signatures may return null. If the Signature Verifier has not been set yet, the method may return null.