gnu.javax.crypto.keyring

Class MaskableEnvelopeEntry

Known Direct Subclasses:
AuthenticatedEntry, EncryptedEntry, PasswordAuthenticatedEntry, PasswordEncryptedEntry

public abstract class MaskableEnvelopeEntry
extends EnvelopeEntry

An envelope entry that can be "masked" -- placed in a state where the envelope's contents cannot be accessed, due to the envelope not being fully decoded, for example.

Field Summary

protected boolean
masked
The masked state.

Fields inherited from class gnu.javax.crypto.keyring.EnvelopeEntry

containingEnvelope, entries

Fields inherited from class gnu.javax.crypto.keyring.Entry

payload, properties, type

Constructor Summary

MaskableEnvelopeEntry(int type)
Constructor for use by subclasses.
MaskableEnvelopeEntry(int type, Properties properties)
Creates a new Entry.

Method Summary

void
add(Entry entry)
Adds an entry to this envelope.
boolean
containsEntry(Entry entry)
Tests if this envelope contains the given entry.
List<E>
get(String alias)
Gets all primitive entries that have the given alias.
List<E>
getEntries()
Returns a copy of all entries this envelope contains.
boolean
isMasked()
Gets the masked state of this object.
boolean
remove(Entry entry)
Removes the specified entry.
boolean
remove(String alias)
Removes all primitive entries that have the specified alias.
protected void
setMasked(boolean masked)
Sets the masked state to the specified value.
String
toString()
Convert this Object to a human-readable String.

Methods inherited from class gnu.javax.crypto.keyring.EnvelopeEntry

add, containsAlias, containsEntry, decodeEnvelope, encodePayload, get, getAliasList, getEntries, remove, remove, setContainingEnvelope, toString

Methods inherited from class gnu.javax.crypto.keyring.Entry

defaultDecode, encode, encodePayload, getPayload, getProperties, toString

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

masked

protected boolean masked
The masked state.

Constructor Details

MaskableEnvelopeEntry

protected MaskableEnvelopeEntry(int type)
Constructor for use by subclasses.

MaskableEnvelopeEntry

public MaskableEnvelopeEntry(int type,
                             Properties properties)
Creates a new Entry.
Parameters:
type - This entry's type.
properties - This entry's properties.
Throws:
IllegalArgumentException - If the properties argument is null, or if the type is out of range.

Method Details

add

public void add(Entry entry)
Adds an entry to this envelope.
Overrides:
add in interface EnvelopeEntry
Parameters:
entry - The entry to add.

containsEntry

public boolean containsEntry(Entry entry)
Tests if this envelope contains the given entry.
Overrides:
containsEntry in interface EnvelopeEntry
Parameters:
entry - The entry to test.
Returns:
True if this envelope contains the given entry.

get

public List<E> get(String alias)
Gets all primitive entries that have the given alias. If there are any masked entries that contain the given alias, they will be returned as well.
Overrides:
get in interface EnvelopeEntry
Parameters:
alias - The alias of the entries to get.
Returns:
A list of all primitive entries that have the given alias.

getEntries

public List<E> getEntries()
Returns a copy of all entries this envelope contains.
Overrides:
getEntries in interface EnvelopeEntry
Returns:
All contained entries.

isMasked

public boolean isMasked()
Gets the masked state of this object. Certain operations on this object will fail if it is masked.
Returns:
The current masked state.

remove

public boolean remove(Entry entry)
Removes the specified entry.
Overrides:
remove in interface EnvelopeEntry
Parameters:
entry - The entry.
Returns:
True if an entry was removed.

remove

public boolean remove(String alias)
Removes all primitive entries that have the specified alias.
Overrides:
remove in interface EnvelopeEntry
Parameters:
alias - The alias of the entries to remove.
Returns:
true if alias was present and was successfully trmoved. Returns false if alias was not present in the list of aliases in this envelope.

setMasked

protected final void setMasked(boolean masked)
Sets the masked state to the specified value.
Parameters:
masked - The new masked state.

toString

public String toString()
Convert this Object to a human-readable String. There are no limits placed on how long this String should be or what it should contain. We suggest you make it as intuitive as possible to be able to place it into System.out.println() and such.

It is typical, but not required, to ensure that this method never completes abruptly with a RuntimeException.

This method will be called when performing string concatenation with this object. If the result is null, string concatenation will instead use "null".

The default implementation returns getClass().getName() + "@" + Integer.toHexString(hashCode()).

Overrides:
toString in interface EnvelopeEntry
Returns:
the String representing this Object, which may be null

MaskableEnvelopeEntry.java -- Copyright (C) 2003, 2006 Free Software Foundation, Inc. This file is a part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.