ptolemy.actor.lib.security
Class KeyReader

java.lang.Object
  extended byptolemy.kernel.util.NamedObj
      extended byptolemy.kernel.InstantiableNamedObj
          extended byptolemy.kernel.Entity
              extended byptolemy.kernel.ComponentEntity
                  extended byptolemy.actor.AtomicActor
                      extended byptolemy.actor.TypedAtomicActor
                          extended byptolemy.actor.lib.security.KeyStoreActor
                              extended byptolemy.actor.lib.security.KeyReader
All Implemented Interfaces:
ptolemy.actor.Actor, ptolemy.kernel.util.Changeable, java.lang.Cloneable, ptolemy.kernel.util.Debuggable, ptolemy.kernel.util.DebugListener, ptolemy.kernel.util.Derivable, ptolemy.actor.Executable, ptolemy.kernel.util.Instantiable, ptolemy.kernel.util.ModelErrorHandler, ptolemy.kernel.util.MoMLExportable, ptolemy.kernel.util.Nameable, java.io.Serializable, ptolemy.actor.TypedActor
Direct Known Subclasses:
PrivateKeyReader, PublicKeyReader

public class KeyReader
extends KeyStoreActor

Read in a keystore from a FileParameter and output a Key.

Keystores are ways to manage keys and certificates. See the KeyStoreActor documentation for more information about keystores.

This class has many parameters, derived classes usually set some of the parameters to reasonable defaults and then hide them by setting the visibility to EXPERT.

Since:
Ptolemy II 4.0
Version:
$Id: KeyReader.java,v 1.32 2004/04/13 05:12:39 cxh Exp $
Author:
Christopher Hylands Brooks
See Also:
PrivateKeyReader, PublicKeyReader, Serialized Form
Accepted Rating:
Red (cxh)
Proposed Rating:
Yellow (cxh)

Nested Class Summary
 
Nested classes inherited from class ptolemy.kernel.Entity
ptolemy.kernel.Entity.ContainedObjectsIterator
 
Field Summary
 ptolemy.data.expr.Parameter getPublicKey
          True if we should get the public key.
 ptolemy.actor.TypedIOPort output
          The output port.
 ptolemy.data.expr.StringParameter signatureAlgorithm
          The name of the signature algorithm used to generate the key.
 ptolemy.actor.TypedIOPort trigger
          The trigger port.
 ptolemy.data.expr.Parameter verifyCertificate
          True if the certificate associated with a key should be verified.
 
Fields inherited from class ptolemy.actor.lib.security.KeyStoreActor
_alias, _keyPassword, _keyStore, _keyStoreType, _loadKeyStoreNeeded, _provider, _storePassword, alias, fileOrURL, keyPassword, keyStoreType, provider, storePassword
 
Fields inherited from class ptolemy.actor.AtomicActor
_stopRequested
 
Fields inherited from class ptolemy.kernel.util.NamedObj
_changeListeners, _changeLock, _changeRequests, _debugging, _debugListeners, _elementName, _isPersistent, _workspace, ATTRIBUTES, CLASSNAME, COMPLETE, CONTENTS, DEEP, FULLNAME, LINKS
 
Fields inherited from interface ptolemy.actor.Executable
COMPLETED, NOT_READY, STOP_ITERATING
 
Constructor Summary
KeyReader(ptolemy.kernel.CompositeEntity container, java.lang.String name)
          Construct an actor with the given container and name.
 
Method Summary
protected  void _updateKey()
          If necessary, update _key by using the values of the alias, fileOrURL and getPublicKey parameters.
 void attributeChanged(ptolemy.kernel.util.Attribute attribute)
          Override the base class to reinitialize the state if the alias, fileOrURL, or getPublicKey parameter is changed.
 void fire()
          Output the java.security.Key that was read in.
 
Methods inherited from class ptolemy.actor.lib.security.KeyStoreActor
_initializeKeyStore, _loadKeyStore
 
Methods inherited from class ptolemy.actor.TypedAtomicActor
_addPort, attributeTypeChanged, clone, newPort, typeConstraintList
 
Methods inherited from class ptolemy.actor.AtomicActor
_createReceivers, clone, connectionsChanged, getDirector, getExecutiveDirector, getFunctionDependency, getManager, initialize, inputPortList, iterate, newReceiver, outputPortList, postfire, prefire, preinitialize, pruneDependencies, removeDependency, setContainer, stop, stopFire, terminate, wrapup
 
Methods inherited from class ptolemy.kernel.ComponentEntity
_adjustDeferrals, _checkContainer, _getContainedObject, _propagateExistence, getContainer, instantiate, isAtomic, isOpaque, propagateExistence, setName
 
Methods inherited from class ptolemy.kernel.Entity
_description, _exportMoMLContents, _removePort, connectedPortList, connectedPorts, containedObjectsIterator, getAttribute, getPort, getPorts, linkedRelationList, linkedRelations, portList, removeAllPorts, setClassDefinition, uniqueName, validateSettables
 
Methods inherited from class ptolemy.kernel.InstantiableNamedObj
_setParent, exportMoML, getChildren, getElementName, getParent, getPrototypeList, isClassDefinition
 
Methods inherited from class ptolemy.kernel.util.NamedObj
_addAttribute, _attachText, _cloneFixAttributeFields, _debug, _debug, _debug, _debug, _debug, _getIndentPrefix, _isMoMLSuppressed, _markContentsDerived, _propagateValue, _removeAttribute, _splitName, _stripNumericSuffix, addChangeListener, addDebugListener, attributeList, attributeList, deepContains, depthInHierarchy, description, description, event, executeChangeRequests, exportMoML, exportMoML, exportMoML, exportMoML, getAttribute, getAttributes, getChangeListeners, getClassName, getDerivedLevel, getDerivedList, getFullName, getModelErrorHandler, getName, getName, getSource, handleModelError, isDeferringChangeRequests, isOverridden, isPersistent, message, propagateValue, propagateValues, removeChangeListener, removeDebugListener, requestChange, setClassName, setDeferringChangeRequests, setDerivedLevel, setModelErrorHandler, setPersistent, setSource, toplevel, toString, workspace
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface ptolemy.actor.Actor
getDirector, getExecutiveDirector, getFunctionDependency, getManager, inputPortList, newReceiver, outputPortList
 
Methods inherited from interface ptolemy.actor.Executable
initialize, iterate, postfire, prefire, preinitialize, stop, stopFire, terminate, wrapup
 
Methods inherited from interface ptolemy.kernel.util.Derivable
getDerivedLevel, getDerivedList, propagateValue
 
Methods inherited from interface ptolemy.kernel.util.Nameable
description, getFullName, getName, getName
 

Field Detail

getPublicKey

public ptolemy.data.expr.Parameter getPublicKey
True if we should get the public key. False if we should get the private key. The default value is true. Getting the private key requires using the keyPassword.


output

public ptolemy.actor.TypedIOPort output
The output port. This port contains an KeyToken that contains a java.security.Key.


trigger

public ptolemy.actor.TypedIOPort trigger
The trigger port. The type of this port is undeclared, meaning that it will resolve to any data type.


signatureAlgorithm

public ptolemy.data.expr.StringParameter signatureAlgorithm
The name of the signature algorithm used to generate the key. This StringParameter is not settable by the user, it is set after initialize() is called and the certificate has been obtained from the KeyStore.


verifyCertificate

public ptolemy.data.expr.Parameter verifyCertificate
True if the certificate associated with a key should be verified. False if the certificate (if any) need not be verified.
Public Keys must be associated with a certificate, so if getPublicKey is true, then this Parameter should be true as well.
Private keys are usually associated with a certificate, so verifying the certificate is a good idea.
Secret keys do not usually have a certificate, so if the key is a secret key, then usually verifyCertificate is set to false.

Constructor Detail

KeyReader

public KeyReader(ptolemy.kernel.CompositeEntity container,
                 java.lang.String name)
          throws ptolemy.kernel.util.IllegalActionException,
                 ptolemy.kernel.util.NameDuplicationException
Construct an actor with the given container and name.

Parameters:
container - The container.
name - The name of this actor.
Throws:
ptolemy.kernel.util.IllegalActionException - If the actor cannot be contained by the proposed container.
ptolemy.kernel.util.NameDuplicationException - If the container already has an actor with this name.
Method Detail

attributeChanged

public void attributeChanged(ptolemy.kernel.util.Attribute attribute)
                      throws ptolemy.kernel.util.IllegalActionException
Override the base class to reinitialize the state if the alias, fileOrURL, or getPublicKey parameter is changed.

Overrides:
attributeChanged in class KeyStoreActor
Parameters:
attribute - The attribute that has changed.
Throws:
ptolemy.kernel.util.IllegalActionException - If the specified attribute is URL and the file cannot be opened.

fire

public void fire()
          throws ptolemy.kernel.util.IllegalActionException
Output the java.security.Key that was read in. Read at most one input token from each channel of the trigger input and discard it. If the trigger input is not connected, then this method does nothing. Derived classes should be sure to call super.fire(), or to consume the trigger input tokens themselves, so that they aren't left unconsumed.

Specified by:
fire in interface ptolemy.actor.Executable
Overrides:
fire in class KeyStoreActor
Throws:
ptolemy.kernel.util.IllegalActionException - Not thrown in this base class.
ptolemy.kernel.util.IllegalActionException - If there's no director.

_updateKey

protected void _updateKey()
                   throws ptolemy.kernel.util.IllegalActionException
If necessary, update _key by using the values of the alias, fileOrURL and getPublicKey parameters.

Throws:
ptolemy.kernel.util.IllegalActionException - If the parent class throws it or if there is a problem with the cryptographic configuration.