Module org.eclipse.milo.opcua.stack.core

Package org.eclipse.milo.opcua.stack.core.security

Class KeyStoreCertificateStore

java.lang.Object

org.eclipse.milo.opcua.stack.core.security.KeyStoreCertificateStore

All Implemented Interfaces:

Closeable, AutoCloseable, CertificateStore

public class KeyStoreCertificateStore
extends Object
implements CertificateStore, Closeable

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	KeyStoreCertificateStore.Settings

Nested classes/interfaces inherited from interface org.eclipse.milo.opcua.stack.core.security.CertificateStore

CertificateStore.Entry

Constructor Summary

Constructors

Constructor	Description
KeyStoreCertificateStore(KeyStoreCertificateStore.Settings settings)

Method Summary

Modifier and Type	Method	Description
void	close()
boolean	contains(NodeId certificateTypeId)	Check if this CertificateStore has an entry for certificateTypeId.
static KeyStoreCertificateStore	createAndInitialize(KeyStoreCertificateStore.Settings settings)	Create and initialize() a new KeyStoreCertificateStore instance.
CertificateStore.Entry	get(NodeId certificateTypeId)	Get the CertificateStore.Entry for certificateTypeId.
protected String	getAlias(NodeId certificateTypeId)	Get the alias to use when accessing certificates of type certificateTypeId.
void	initialize()
protected void	loadEntries()	Call get(NodeId) for each of the supported certificate types to pre-emptively load them into memory.
CertificateStore.Entry	remove(NodeId certificateTypeId)	Remove the CertificateStore.Entry for certificateTypeId.
void	set(NodeId certificateTypeId, CertificateStore.Entry entry)	Set the CertificateStore.Entry for certificateTypeId.

Methods inherited from class java.lang.Object

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

Constructor Details

KeyStoreCertificateStore

public KeyStoreCertificateStore(KeyStoreCertificateStore.Settings settings)

Method Details

initialize

public void initialize()
                throws Exception

Throws:

Exception

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException

contains

public boolean contains(NodeId certificateTypeId)
                 throws Exception

Description copied from interface: CertificateStore

Check if this CertificateStore has an entry for certificateTypeId.

Specified by:

contains in interface CertificateStore

Parameters:

certificateTypeId - the id to check.

Returns:

true if this CertificateStore is managing an entry for certificateTypeId.

Throws:

Exception - if an error occurs while checking.

get

public CertificateStore.Entry get(NodeId certificateTypeId)
                           throws Exception

Description copied from interface: CertificateStore

Get the CertificateStore.Entry for certificateTypeId.

Specified by:

get in interface CertificateStore

Parameters:

certificateTypeId - the id of the certificate type to get the CertificateStore.Entry for.

Returns:

the CertificateStore.Entry for certificateTypeId, or null if no entry exists for certificateTypeId.

Throws:

Exception - if an error occurs while getting the CertificateStore.Entry.

remove

public CertificateStore.Entry remove(NodeId certificateTypeId)
                              throws Exception

Description copied from interface: CertificateStore

Remove the CertificateStore.Entry for certificateTypeId.

Specified by:

remove in interface CertificateStore

Parameters:

certificateTypeId - the id of the certificate type to remove the CertificateStore.Entry for.

Returns:

the CertificateStore.Entry that was removed, or null if no entry exists for certificateTypeId.

Throws:

Exception - if an error occurs while removing the CertificateStore.Entry.

set

public void set(NodeId certificateTypeId,
 CertificateStore.Entry entry)
         throws Exception

Description copied from interface: CertificateStore

Set the CertificateStore.Entry for certificateTypeId.

Specified by:

set in interface CertificateStore

Parameters:

certificateTypeId - the alias to set the CertificateStore.Entry for.

entry - the CertificateStore.Entry to set.

Throws:

Exception - if an error occurs while setting the CertificateStore.Entry.

getAlias

protected String getAlias(NodeId certificateTypeId)

Get the alias to use when accessing certificates of type certificateTypeId.

Parameters:

certificateTypeId - the NodeId of the certificate type.

Returns:

the alias to use when accessing certificates of type certificateTypeId.

loadEntries

protected void loadEntries()
                    throws Exception

Call get(NodeId) for each of the supported certificate types to pre-emptively load them into memory.

Throws:

Exception - if an error occurs while loading the entries.

createAndInitialize

public static KeyStoreCertificateStore createAndInitialize(KeyStoreCertificateStore.Settings settings)
                                                    throws Exception

Create and initialize() a new KeyStoreCertificateStore instance.

Parameters:

settings - the KeyStoreCertificateStore.Settings to use.

Returns:

an initialized KeyStoreCertificateStore instance.

Throws:

Exception - if an error occurs while initializing the KeyStoreCertificateStore.