org.picketlink.idm

Interface IDMMessages

@MessageBundle(projectCode="PLIDM")
public interface IDMMessages

MessageBundle interface for all exceptions thrown by the IDM.

Methods names follow the rule: [Context]+[Short Message Description]. For example, the name storeConfigLockedFeatureSet. In this case the [Context] is storeConfig, meaning that this message is used by the identity store configuration. The LockedFeatureSet is a short description for the message itself.

General messages may not have a [Context].

When creating new messages, you may or not identify messages with an identifier. The identifier is only used for messages with an important meaning for users, from which they can easily identify the context of an exception or failure.

Messages with no identifier usually means they are used as root exceptions, with more details about an exception or failure.

Author:

Pedro Silva

Field Summary

Fields

Modifier and Type	Field and Description
static IDMMessages	MESSAGES

Method Summary

Methods

Modifier and Type	Method and Description
SecurityConfigurationException	configBuildMultipleConfigurationExists()
SecurityConfigurationException	configCouldNotCreateConfiguration(Exception sce)
SecurityConfigurationException	configCouldNotCreateStore(Class<? extends IdentityStore> storeClass, IdentityStoreConfiguration storeConfiguration, Exception e)
SecurityConfigurationException	configInvalidConfiguration(String name, Throwable t)
SecurityConfigurationException	configJpaStoreMappedPropertyNotFound(Class<?> entityType, String propertyName, Class<?> type)
SecurityConfigurationException	configJpaStoreNoEntityClassesProvided()
SecurityConfigurationException	configJpaStoreRequiredMappingAnnotation(Class<?> entityType, Class<? extends Annotation> annotation)
SecurityConfigurationException	configMultipleConfigurationsFoundWithCredentialSupport()
SecurityConfigurationException	configMultipleConfigurationsFoundWithSameName(String name)
SecurityConfigurationException	configNoConfigurationProvided()
SecurityConfigurationException	configNoIdentityConfigurationProvided()
SecurityConfigurationException	configStoreDuplicatedSupportedType(Class<?> supportedType)
SecurityConfigurationException	configStoreMultiplePartitionConfigExists(IdentityStoreConfiguration config1, IdentityStoreConfiguration config2)
SecurityConfigurationException	configStoreNoIdentityStoreConfigProvided()
SecurityConfigurationException	configUnknownStoreForConfiguration(IdentityStoreConfiguration storeConfiguration)
IdentityManagementException	credentialCouldNotEncodePassword(UnsupportedEncodingException e)
IdentityManagementException	credentialDigestInvalidRealm()
IdentityManagementException	credentialHandlerNotFoundForCredentialType(Class<?> class1)
IdentityManagementException	credentialInvalidEncodingAlgorithm(String algorithm, PasswordEncoder encoder, Throwable t)
IdentityManagementException	credentialInvalidPassword()
IdentityManagementException	credentialNoStoreForCredentials(Class<?> credentialClass)
<T extends CredentialStorage> IdentityManagementException	credentialRetrievalFailed(Account account, Class<T> storageClass, Throwable t)
IdentityManagementException	credentialUnsupportedType(Class<?> type, CredentialHandler handler)
IdentityManagementException	credentialUpdateFailed(Account account, Object credential, Throwable t)
IdentityManagementException	credentialValidationFailed(Credentials credentials, Throwable t)
IdentityManagementException	instantiationError(Class<?> type, Throwable t)
IdentityManagementException	marshallingError(Throwable t)
IdentityManagementException	nullArgument(String description)
IdentityManagementException	permissionGrantFailed(Permission permission, Throwable t)
IdentityManagementException	unexpectedType(Class<?> unexpectedType)
IdentityManagementException	unmarshallingError(Throwable t)

Field Detail

MESSAGES

static final IDMMessages MESSAGES

Method Detail

instantiationError

@Message(id=1,
         value="Error creating instance for type [%s].")
IdentityManagementException instantiationError(Class<?> type,
                                                     @Cause
                                                     Throwable t)

nullArgument

@Message(id=2,
         value="Null argument: [%s].")
IdentityManagementException nullArgument(String description)

unmarshallingError

@Message(id=3,
         value="Error unmarshalling object.")
IdentityManagementException unmarshallingError(@Cause
                                                     Throwable t)

marshallingError

@Message(id=4,
         value="Error marshalling object.")
IdentityManagementException marshallingError(@Cause
                                                   Throwable t)

unexpectedType

@Message(id=5,
         value="Unexpected type [%s].")
IdentityManagementException unexpectedType(Class<?> unexpectedType)

credentialValidationFailed

@Message(id=200,
         value="Credential validation failed [%s].")
IdentityManagementException credentialValidationFailed(Credentials credentials,
                                                             @Cause
                                                             Throwable t)

credentialUpdateFailed

@Message(id=201,
         value="Credential update failed for account [%s] and type [%s].")
IdentityManagementException credentialUpdateFailed(Account account,
                                                         Object credential,
                                                         @Cause
                                                         Throwable t)

credentialNoStoreForCredentials

@Message(id=202,
         value="No IdentityStore found for credential class [%s]")
IdentityManagementException credentialNoStoreForCredentials(Class<?> credentialClass)

credentialUnsupportedType

@Message(id=203,
         value="Credentials class [%s] not supported by this handler [%s].")
IdentityManagementException credentialUnsupportedType(Class<?> type,
                                                            CredentialHandler handler)

credentialRetrievalFailed

@Message(id=204,
         value="Credentials could not be retrieved for account [%s] and storage [%s].")
<T extends CredentialStorage> IdentityManagementException credentialRetrievalFailed(Account account,
                                                                                          Class<T> storageClass,
                                                                                          @Cause
                                                                                          Throwable t)

credentialDigestInvalidRealm

@Message(value="Invalid Realm or it was not provided.")
IdentityManagementException credentialDigestInvalidRealm()

credentialInvalidPassword

@Message(value="Invalid Password or it was not provided.")
IdentityManagementException credentialInvalidPassword()

credentialCouldNotEncodePassword

@Message(value="Could not encode password.")
IdentityManagementException credentialCouldNotEncodePassword(@Cause
                                                                   UnsupportedEncodingException e)

credentialHandlerNotFoundForCredentialType

@Message(value="No suitable CredentialHandler available for validating Credentials of type [%s].")
IdentityManagementException credentialHandlerNotFoundForCredentialType(Class<?> class1)

credentialInvalidEncodingAlgorithm

@Message(value="No such algorithm [%s] for encoding passwords. Using PasswordEncoder [%s].")
IdentityManagementException credentialInvalidEncodingAlgorithm(String algorithm,
                                                                     PasswordEncoder encoder,
                                                                     @Cause
                                                                     Throwable t)

configCouldNotCreateConfiguration

@Message(id=700,
         value="Could not create configuration.")
SecurityConfigurationException configCouldNotCreateConfiguration(@Cause
                                                                       Exception sce)

configInvalidConfiguration

@Message(id=701,
         value="Invalid configuration [%s].")
SecurityConfigurationException configInvalidConfiguration(String name,
                                                                @Cause
                                                                Throwable t)

configNoConfigurationProvided

@Message(id=702,
         value="You must provide at least one configuration.")
SecurityConfigurationException configNoConfigurationProvided()

configBuildMultipleConfigurationExists

@Message(id=703,
         value="You have provided more than one configuration. Use the buildAll method instead.")
SecurityConfigurationException configBuildMultipleConfigurationExists()

configNoIdentityConfigurationProvided

@Message(id=704,
         value="At least one IdentityConfiguration must be provided")
SecurityConfigurationException configNoIdentityConfigurationProvided()

configStoreNoIdentityStoreConfigProvided

@Message(id=705,
         value="You must configure at least one identity store.")
SecurityConfigurationException configStoreNoIdentityStoreConfigProvided()

configStoreDuplicatedSupportedType

@Message(id=706,
         value="Duplicated supported types [%s] found for identity store configuration. Check your identity store configuration for duplicated types, considering their hierarchy.")
SecurityConfigurationException configStoreDuplicatedSupportedType(Class<?> supportedType)

configMultipleConfigurationsFoundWithCredentialSupport

@Message(id=707,
         value="Multiple configuration with credential support.")
SecurityConfigurationException configMultipleConfigurationsFoundWithCredentialSupport()

configJpaStoreNoEntityClassesProvided

@Message(value="Error initializing JpaIdentityStore - no entity classes configured.")
SecurityConfigurationException configJpaStoreNoEntityClassesProvided()

configJpaStoreRequiredMappingAnnotation

@Message(value="Entity [%s] must have a field annotated with %s.")
SecurityConfigurationException configJpaStoreRequiredMappingAnnotation(Class<?> entityType,
                                                                             Class<? extends Annotation> annotation)

configJpaStoreMappedPropertyNotFound

@Message(value="Mapped attribute [%s.%s] does not map to any field for type [%s].")
SecurityConfigurationException configJpaStoreMappedPropertyNotFound(Class<?> entityType,
                                                                          String propertyName,
                                                                          Class<?> type)

configUnknownStoreForConfiguration

@Message(value="Unknown IdentityStore class for configuration [%s].")
SecurityConfigurationException configUnknownStoreForConfiguration(IdentityStoreConfiguration storeConfiguration)

configCouldNotCreateStore

@Message(value="Error while creating IdentityStore [%s] instance for configuration [%s].")
SecurityConfigurationException configCouldNotCreateStore(Class<? extends IdentityStore> storeClass,
                                                               IdentityStoreConfiguration storeConfiguration,
                                                               @Cause
                                                               Exception e)

configStoreMultiplePartitionConfigExists

@Message(value="Only a single identity store config can support partitions. Found [%s] and [%s].")
SecurityConfigurationException configStoreMultiplePartitionConfigExists(IdentityStoreConfiguration config1,
                                                                              IdentityStoreConfiguration config2)

configMultipleConfigurationsFoundWithSameName

@Message(value="Multiple configuration with the same name [%s].")
SecurityConfigurationException configMultipleConfigurationsFoundWithSameName(String name)

permissionGrantFailed

@Message(value="Could not grant Permission [%s].")
IdentityManagementException permissionGrantFailed(Permission permission,
                                                        @Cause
                                                        Throwable t)