org.xipki.security.pkcs11

Class P11Module

java.lang.Object

org.xipki.security.pkcs11.P11Module

Direct Known Subclasses:

NativeP11Module

public abstract class P11Module
extends Object

PKCS#11 module.

Since:

2.0.0

Author:

Lijun Liao

Field Summary

Fields

Modifier and Type	Field and Description
protected P11ModuleConf	conf

Constructor Summary

Constructors

Constructor and Description
P11Module(P11ModuleConf conf)

Method Summary

Modifier and Type	Method and Description
abstract void	close()
P11ModuleConf	getConf()
abstract String	getDescription()
String	getName()
P11Slot	getSlot(P11SlotId slotId) Returns slot for the given slotId.
P11SlotId	getSlotIdForId(long id)
P11SlotId	getSlotIdForIndex(int index)
List<P11SlotId>	getSlotIds()
boolean	isReadOnly()
protected void	setSlots(Set<P11Slot> slots)

Methods inherited from class java.lang.Object

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

Field Detail

conf

protected final P11ModuleConf conf

Constructor Detail

P11Module

public P11Module(P11ModuleConf conf)

Method Detail

close

public abstract void close()

getDescription

public abstract String getDescription()

getName

public String getName()

isReadOnly

public boolean isReadOnly()

getConf

public P11ModuleConf getConf()

setSlots

protected void setSlots(Set<P11Slot> slots)

getSlot

public P11Slot getSlot(P11SlotId slotId)
                throws org.xipki.pkcs11.wrapper.TokenException

Returns slot for the given slotId.

Parameters:

slotId - slot identifier. Must not be null.

Returns:

the slot

Throws:

org.xipki.pkcs11.wrapper.TokenException - if PKCS#11 token error occurs

getSlotIds

public List<P11SlotId> getSlotIds()

getSlotIdForIndex

public P11SlotId getSlotIdForIndex(int index)
                            throws org.xipki.pkcs11.wrapper.TokenException

Throws:

org.xipki.pkcs11.wrapper.TokenException

getSlotIdForId

public P11SlotId getSlotIdForId(long id)
                         throws org.xipki.pkcs11.wrapper.TokenException

Throws:

org.xipki.pkcs11.wrapper.TokenException