org.picketlink.identity.federation.core.saml.v2.metadata.store

Interface IMetadataConfigurationStore

All Known Implementing Classes:

FileBasedMetadataConfigurationStore

public interface IMetadataConfigurationStore

Configuration Store for the metadata

Since:

Apr 27, 2009

Author:

Anil.Saldhana@redhat.com

Method Summary

Methods

Modifier and Type	Method and Description
void	bootstrap() Perform any bootstrap or initialization the store needs.
void	cleanup() Perform final cleanup if needed.
void	delete(String id) Delete the descriptor from the external data sink
void	deleteTrustedProviders(String id) Delete the trusted providers from the external data sink
Set<String>	getIdentityProviderID() Get a set of the identity provider ID, which can individually be drilled down to get additional trusted provider information
Set<String>	getServiceProviderID() Get a set of the service provider ID, which can individually be drilled down to get additional trusted provider information
EntityDescriptorType	load(String id) Load the descriptor from the external data sink
Map<String,String>	loadTrustedProviders(String id) Get the Trusted Providers
void	persist(EntityDescriptorType entity, String id) Persist into an external sink (file system, ldap, db etc)
void	persistTrustedProviders(String id, Map<String,String> trusted) Persist the map of trusted providers

Method Detail

bootstrap

void bootstrap()

Perform any bootstrap or initialization the store needs.

getServiceProviderID

Set<String> getServiceProviderID()

Get a set of the service provider ID, which can individually be drilled down to get additional trusted provider information

Returns:

getIdentityProviderID

Set<String> getIdentityProviderID()

Get a set of the identity provider ID, which can individually be drilled down to get additional trusted provider information

Returns:

loadTrustedProviders

Map<String,String> loadTrustedProviders(String id)
                                        throws IOException,
                                               ClassNotFoundException

Get the Trusted Providers

Parameters:

id -

Returns:

a map of name of provider, metadata urls

Throws:

{@link - IOException}

{@link - ClassNotFoundException}

IOException

ClassNotFoundException

persistTrustedProviders

void persistTrustedProviders(String id,
                           Map<String,String> trusted)
                             throws IOException

Persist the map of trusted providers

Parameters:

id -

trusted -

Throws:

{@link - IOException}

IOException

persist

void persist(EntityDescriptorType entity,
           String id)
             throws IOException

Persist into an external sink (file system, ldap, db etc)

Parameters:

entity -

id - An unique identifier useful for retrieval

Throws:

{@link - IOException}

IOException

load

EntityDescriptorType load(String id)
                          throws IOException

Load the descriptor from the external data sink

Parameters:

id - unique identifier used during persistence

Returns:

Throws:

{@link - IOException}

IOException

delete

void delete(String id)

Delete the descriptor from the external data sink

Parameters:

id -

deleteTrustedProviders

void deleteTrustedProviders(String id)

Delete the trusted providers from the external data sink

Parameters:

id -

cleanup

void cleanup()

Perform final cleanup if needed.