org.dcache.xrootd.plugins.alice

Class Envelope

java.lang.Object

org.dcache.xrootd.plugins.alice.Envelope

public class Envelope
extends Object

This class represents an immutable authorization envelope. For a detailed format description please refer to "Authorization of data access in distributed storage systems" by Feichtinger and Peters.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Envelope.GridFile This class encapsulates all permisson and location information for one file in the grid context, particularly the mapping between the logical filename (lfn) and the physical filename (transport URI, TURL) as well as the access permission granted by the file catalogue.

Field Summary

Fields

Modifier and Type	Field and Description
static Map<String,org.dcache.xrootd.protocol.XrootdProtocol.FilePerm>	filePermissions

Constructor Summary

Constructors

Constructor and Description
Envelope(String envelope) Parses the envelope and verifies its validity.

Method Summary

Modifier and Type	Method and Description
Date	getCreationDate() Gets the creation time of the envelope formatted as Date
long	getCreationTime() Gets the creation time of the envelope
String	getCreator() Returns the name of the creator
Date	getExpirationDate() Returns the expiration time formatted as Date
long	getExpirationTime() Returns the experation time
List<Envelope.GridFile>	getFiles() Returns access to the list of specified files
boolean	isValid() Returns whether this envelope is valid or already expired
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

filePermissions

public static final Map<String,org.dcache.xrootd.protocol.XrootdProtocol.FilePerm> filePermissions

Constructor Detail

Envelope

public Envelope(String envelope)
         throws CorruptedEnvelopeException,
                CredentialException

Parses the envelope and verifies its validity.

Parameters:

envelope - the envelope in plain text to be parsed

Throws:

CorruptedEnvelopeException - if parsing fails

CredentialException

Method Detail

getCreationTime

public long getCreationTime()

Gets the creation time of the envelope

Returns:

the creation time as an UNIX timestamp

getCreationDate

public Date getCreationDate()

Gets the creation time of the envelope formatted as Date

Returns:

the creation time as Date

getCreator

public String getCreator()

Returns the name of the creator

Returns:

the creator's name

getExpirationTime

public long getExpirationTime()

Returns the experation time

Returns:

the experation time as an UNIX timestamp or 0 if envelope never expires

getExpirationDate

public Date getExpirationDate()

Returns the expiration time formatted as Date

Returns:

the expiration time as Date or null if envelope never expires

isValid

public boolean isValid()

Returns whether this envelope is valid or already expired

Returns:

true if, and only if, the expiration date is ahead the current date or if expire is equal to zero (will never expire)

getFiles

public List<Envelope.GridFile> getFiles()

Returns access to the list of specified files

Returns:

an interator the the file list

toString

public String toString()

Overrides:

toString in class Object