PicketLinkMessages.java

/*
 * JBoss, Home of Professional Open Source.
 * Copyright 2012, Red Hat, Inc., and individual contributors
 * as indicated by the @author tags. See the copyright.txt file in the
 * distribution for a full listing of individual contributors.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */

package org.picketlink.identity.federation;

import java.io.IOException;
import java.security.GeneralSecurityException;

import javax.security.auth.login.LoginException;
import javax.xml.crypto.dsig.XMLSignatureException;
import javax.xml.stream.Location;
import javax.xml.ws.WebServiceException;

import org.jboss.logging.Cause;
import org.jboss.logging.Message;
import org.jboss.logging.MessageBundle;
import org.jboss.logging.Messages;
import org.picketlink.identity.federation.core.exceptions.ConfigurationException;
import org.picketlink.identity.federation.core.exceptions.ParsingException;
import org.picketlink.identity.federation.core.exceptions.ProcessingException;
import org.picketlink.identity.federation.core.interfaces.TrustKeyConfigurationException;
import org.picketlink.identity.federation.core.interfaces.TrustKeyProcessingException;
import org.picketlink.identity.federation.core.saml.v2.exceptions.AssertionExpiredException;
import org.picketlink.identity.federation.core.saml.v2.exceptions.IssueInstantMissingException;
import org.picketlink.identity.federation.core.saml.v2.exceptions.IssuerNotTrustedException;
import org.picketlink.identity.federation.core.saml.v2.exceptions.SignatureValidationException;
import org.picketlink.identity.federation.core.wstrust.WSTrustException;
import org.picketlink.identity.federation.web.constants.GeneralConstants;
import org.w3c.dom.Element;

/**
 * @author <a href="mailto:psilva@redhat.com">Pedro Silva</a>
 * 
 */
@MessageBundle(projectCode = "PLFED")
public interface PicketLinkMessages {

    PicketLinkMessages MESSAGES = Messages.getBundle(PicketLinkMessages.class);

    @Message(id = 1, value = "Invalid security token request")
    WebServiceException wsTrustInvalidTokenRequestError();

    @Message(id = 2, value = "Encountered configuration exception")
    WebServiceException wsTrustConfigurationError(@Cause Throwable t);

    @Message(id = 3, value = "Exception in handling token request")
    WebServiceException wsTrustHandlingTokenRequestError(@Cause Throwable t);

    @Message(id = 4, value = "Error writing response")
    WebServiceException wsTrustResponseWritingError(@Cause Throwable t);

    @Message(id = 5, value = "Error parsing the configuration file")
    ConfigurationException stsConfigurationFileParsingError(@Cause Throwable t);

    @Message(id = 6, value = "Error generating combined secret key")
    WSTrustException wsTrustCombinedSecretKeyError(@Cause Throwable t);

    @Message(id = 7, value = "Unable to construct the key manager")
    RuntimeException stsUnableToConstructKeyManagerError(@Cause Throwable t);

    @Message(id = 8, value = "Unable to locate client public key")
    WSTrustException wsTrustClientPublicKeyError();

    @Message(id = 9, value = "Invalid Digital Signature: %s")
    XMLSignatureException signatureInvalidError(String message, @Cause Throwable t);

    @Message(id = 10, value = "Error obtaining public key for service: %s")
    RuntimeException stsPublicKeyError(String serviceName, @Cause Throwable t);

    @Message(id = 11, value = "Error obtaining signing key pair")
    RuntimeException stsSigningKeyPairError(@Cause Throwable t);

    @Message(id = 12, value = "Error obtaining public key certificate")
    RuntimeException stsPublicKeyCertError(@Cause Throwable t);

    @Message(id = 13, value = "No Security Token Provider found in configuration:[%s][ProtoCtx=%s]")
    ProcessingException stsNoTokenProviderError(String configuration, String protocolContext);

    @Message(id = 14, value = "Authn Request ID verification failed")
    ProcessingException samlHandlerFailedInResponseToVerificarionError();

    @Message(id = 15, value = "IDP Authentication Failed")
    SecurityException samlHandlerIDPAuthenticationFailedError();

    @Message(id = 16, value = "Should not be the same: %s")
    IllegalArgumentException shouldNotBeTheSameError(String message);

    @Message(id = 17, value = "Configuration File missing: %s")
    RuntimeException configurationFileMissing(String configFile);

    @Message(id = 18, value = "Resource not found: %s")
    ProcessingException resourceNotFoundError(String fileName);

    @Message(id = 19, value = "Validation check failed")
    GeneralSecurityException samlIDPValidationCheckFailed();

    @Message(id = 22, value = "Principal Not Found")
    ProcessingException samlHandlerPrincipalNotFoundError();

    @Message(id = 23, value = "Trust Key Manager Missing")
    TrustKeyConfigurationException trustKeyManagerMissing();

    @Message(id = 26, value = "Response was not of type catalina response. Received: %s")
    RuntimeException samlSPResponseNotCatalinaResponseError(Object response);

    @Message(id = 28, value = "Audit Manager Is Not Set")
    IllegalStateException auditNullAuditManagerError();

    @Message(id = 35, value = "Unable to fallback on local auth")
    IOException unableLocalAuthentication(@Cause Throwable t);

    @Message(id = 39, value = "Failed to validate assertion: STS configuration file not specified")
    LoginException authSTSConfigFileNotFound();

    @Message(id = 41, value = "Error handling callback")
    LoginException authErrorHandlingCallbackError(@Cause Throwable t);

    @Message(id = 44, value = "Failed to parse assertion element")
    LoginException authFailedToParseSAMLAssertionError(@Cause Throwable t);

    @Message(id = 55, value = "KeyStoreKeyManager : KeyStore is null")
    IllegalStateException keyStoreNullStore();

    @Message(id = 56, value = "KeyStoreKeyManager : Keystore not located: %s")
    RuntimeException keyStoreNotLocated(String keyStore);

    @Message(id = 57, value = "KeyStoreKeyManager : Signing Key Pass is null")
    RuntimeException keyStoreNullSigningKeyPass();

    @Message(id = 58, value = "KeyStoreKeyManager : Domain Alias missing for : %s")
    IllegalStateException keyStoreMissingDomainAlias(String domain);

    @Message(id = 59, value = "KeyStoreKeyManager : Alias is null")
    IllegalStateException keyStoreNullAlias();

    @Message(id = 60, value = "Parser : Expected start tag: %s ::Found <%s>")
    RuntimeException parserExpectedTag(String tag, String foundElementTag);

    @Message(id = 61, value = "Parser: Unknown End Element: %s")
    RuntimeException parserUnknownEndElement(String endElementName);

    @Message(id = 62, value = "Parser : Unknown tag: %s ::location= %s")
    RuntimeException parseUnknownTag(String tag, Location location);

    @Message(id = 63, value = "Parser: Required attribute missing: %s")
    ParsingException parseRequiredAttribute(String attribute);

    @Message(id = 64, value = "Parser: Unknown Start Element: %s ::location= %s")
    RuntimeException parserUnknownStartElement(String elementName, Location location);

    @Message(id = 65, value = "Parser : Unknown xsi:type= %s")
    ParsingException parserUnknownXSI(String xsiTypeValue);

    @Message(id = 66, value = "Parser : Expected end tag: %s")
    ParsingException parserExpectedEndTag(String tagName);

    @Message(id = 67, value = "Parser : Parsing has failed: %s")
    RuntimeException parserFailed(String elementName);

    @Message(id = 68, value = "Parser : Start Element is null")
    IllegalStateException parserNullStartElement();

    @Message(id = 69, value = "Parser: Type not supported: %s")
    RuntimeException unsupportedType(String name);

    @Message(id = 70, value = "Parser : Parsing exception.")
    ParsingException parserException(@Cause Throwable t);

    @Message(id = 71, value = "Parser: Expected text value: %s")
    ParsingException parserExpectedTextValue(String string);

    @Message(id = 72, value = "Parser: Expected xsi:type: %s")
    RuntimeException parserExpectedXSI(String expectedXsi);

    @Message(id = 73, value = "Parser: Unable to parse token request: security token is null")
    ParsingException parserUnableParsingNullToken();

    @Message(id = 74, value = "Parsing Error.")
    ParsingException parserError(@Cause Throwable t);

    @Message(id = 75, value = "File could not be located : %s")
    IllegalStateException fileNotLocated(String policyConfigFileName);

    @Message(id = 76, value = "Option not set: %s")
    IllegalStateException optionNotSet(String option);

    @Message(id = 77, value = "Injected Value Missing: %s")
    RuntimeException injectedValueMissing(String value);

    @Message(id = 78, value = "Null Parameter: %s")
    IllegalArgumentException nullArgument(String argument);

    @Message(id = 79, value = "Assertion has expired")
    ProcessingException assertionExpiredError();

    @Message(id = 80, value = "Invalid Assertion")
    ProcessingException assertionInvalidError();

    @Message(id = 81, value = "Writer: Unknown Type: %s")
    RuntimeException writerUnknownTypeError(String name);

    @Message(id = 82, value = "Not Implemented Yet: %s")
    RuntimeException notImplementedYet(String feature);

    @Message(id = 83, value = "Writer: Null Value: %s")
    ProcessingException writerNullValueError(String value);

    @Message(id = 84, value = "Writer: Unsupported Attribute Value: %s")
    RuntimeException writerUnsupportedAttributeValueError(String value);

    @Message(id = 85, value = "IssuerInfo missing status code")
    IllegalArgumentException issuerInfoMissingStatusCodeError();

    @Message(id = 86, value = "Cannot create instance of: %s")
    ProcessingException couldNotCreateInstance(String fqn, @Cause Throwable t);

    @Message(id = 87, value = "System Property missing: %s")
    RuntimeException systemPropertyMissingError(String property);

    @Message(id = 88, value = "Null IssueInstant")
    IssueInstantMissingException samlIssueInstantMissingError();

    @Message(id = 89, value = "Unknown Object Type: %s")
    RuntimeException unknownObjectType(Object attrValue);

    @Message(id = 90, value = "Unknown Signature Algorithm: %s")
    RuntimeException signatureUnknownAlgo(String algo);

    @Message(id = 91, value = "Writer: Invalid KeyInfo object: content cannot be empty")
    ProcessingException writerInvalidKeyInfoNullContentError();

    @Message(id = 92, value = "Null Value: %s")
    RuntimeException nullValue(String nullValue);

    @Message(id = 93, value = "Not Serializable: %s")
    IOException notSerializableError(String message);

    @Message(id = 94, value = "Not equal: %s and %s")
    RuntimeException notEqualError(String first, String second);

    @Message(id = 95, value = "Wrong type: %s")
    IllegalArgumentException wrongTypeError(String message);

    @Message(id = 97, value = "Unknown Encryption Algorithm: %s")
    RuntimeException encryptUnknownAlgoError(String certAlgo);

    @Message(id = 98, value = "Missing Document Element: %s")
    IllegalStateException domMissingDocElementError(String element);

    @Message(id = 99, value = "Missing Element: %s")
    IllegalStateException domMissingElementError(String element);

    @Message(id = 100, value = "Signing Process Failure")
    XMLSignatureException signatureError(@Cause Throwable t);

    @Message(id = 101, value = "Encryption Process Failure")
    RuntimeException encryptProcessError(@Cause Throwable t);

    @Message(id = 102, value = "Processing Exception")
    ProcessingException processingError(@Cause Throwable t);

    @Message(id = 103, value = "Error while configuring the audit capabilities")
    ConfigurationException auditConfigurationError(@Cause Throwable t);

    @Message(id = 104, value = "Class Not Loaded: %s")
    ProcessingException classNotLoadedError(String fqn);

    @Message(id = 105, value = "Configuration Exception")
    ConfigurationException configurationError(@Cause Throwable t);

    @Message(id = 106, value = "PDP : Error while processing the message.")
    RuntimeException xacmlPDPMessageProcessingError(@Cause Throwable t);

    @Message(id = 107, value = "Invalid Argument Exception: %s")
    IllegalArgumentException invalidArgumentError(String message);

    @Message(id = 108, value = "KeyStoreKeyManager : Processing error")
    TrustKeyProcessingException keyStoreProcessingError(@Cause Throwable t);

    @Message(id = 109, value = "KeyStoreKeyManager : Configuration error.")
    TrustKeyConfigurationException keyStoreConfigurationError(@Cause Throwable t);

    @Message(id = 110, value = "Security Token Service Exception")
    WebServiceException stsWSError(@Cause Throwable t);

    @Message(id = 111, value = "Invalid request type: %s")
    WSTrustException stsWSInvalidRequestTypeError(String requestType);

    @Message(id = 112, value = "WS-Trust Processing Exception")
    WSTrustException stsError(@Cause Throwable t);

    @Message(id = 113, value = "Unable to decode password: %s")
    RuntimeException stsUnableToDecodePasswordError(String password);

    @Message(id = 114, value = "Could not load properties from %s")
    IllegalStateException couldNotLoadProperties(String configFile);

    @Message(id = 115, value = "Error creating KeyInfoType")
    WSTrustException stsKeyInfoTypeCreationError(@Cause Throwable t);

    @Message(id = 116, value = "Could not issue a SAML Security Token")
    LoginException authCouldNotIssueSAMLToken();

    @Message(id = 117, value = "Error during login/authentication")
    LoginException authLoginError(@Cause Throwable t);

    @Message(id = 118, value = "Could not create WSTrustClient")
    IllegalStateException authCouldNotCreateWSTrustClient(@Cause Throwable t);

    @Message(id = 119, value = "Could not validate the SAML Security Token : %s")
    LoginException authCouldNotValidateSAMLToken(Element token);

    @Message(id = 120, value = "Could not locate a Security Token from the callback")
    LoginException authCouldNotLocateSecurityTokenError();

    @Message(id = 121, value = "Invalid cancel request: missing required CancelTarget")
    ProcessingException wsTrustNullCancelTargetError();

    @Message(id = 122, value = "Failed to marshall assertion")
    ProcessingException samlMarshallError(@Cause Throwable t);

    @Message(id = 123, value = "Invalid renew request: missing required RenewTarget")
    ProcessingException wsTrustNullRenewTargetError();

    @Message(id = 124, value = "Error unmarshalling assertion")
    ProcessingException samlUnmarshallError(@Cause Throwable t);

    @Message(id = 125, value = "SAML Assertion with id %s has been canceled and cannot be renewed")
    ProcessingException samlAssertionRevokedCouldNotRenew(String id);

    @Message(id = 126, value = "Bad validate request: missing required ValidateTarget")
    ProcessingException wsTrustNullValidationTargetError();

    @Message(id = 127, value = "Unable to get DatatypeFactory instance")
    RuntimeException wsTrustUnableToGetDataTypeFactoryError(@Cause Throwable t);

    @Message(id = 128, value = "Validation status code is missing")
    ProcessingException wsTrustValidationStatusCodeMissing();

    @Message(id = 129, value = "Unknown credential type: %s")
    RuntimeException unknownCredentialTypeError(String name);

    @Message(id = 130, value = "Assertion not found in the handler request")
    RuntimeException samlHandlerAssertionNotFound();

    @Message(id = 131, value = "AuthnRequest is null")
    ProcessingException samlHandlerAuthnRequestIsNullError();

    @Message(id = 132, value = "No assertions in reply from IDP")
    IllegalArgumentException samlHandlerNoAssertionFromIDPError();

    @Message(id = 133, value = "Null encrypted assertion element")
    ProcessingException samlHandlerNullEncryptedAssertion();

    @Message(id = 134, value = "Assertion has expired with errors")
    ProcessingException assertionExpiredErrorWithException(@Cause AssertionExpiredException aee);

    @Message(id = 135, value = "Unknown role object type : %s")
    RuntimeException unsupportedRoleType(Object attrValue);

    @Message(id = 136, value = "Issuer not Trusted by the IDP: %s")
    IssuerNotTrustedException samlHandlerIssuerNotTrustedError(String issuer);

    @Message(id = 137, value = "Error while checking the trusted domains.")
    IssuerNotTrustedException samlHandlerIssuerNotTrustedError(@Cause Throwable t);

    @Message(id = 138, value = "Trust or Domains element is missing. Check your configuration.")
    ConfigurationException samlHandlerTrustElementMissingError();

    @Message(id = 139, value = "Identity Server not found")
    ProcessingException samlHandlerIdentityServerNotFoundError();

    @Message(id = 140, value = "Key Pair not found")
    ProcessingException samlHandlerKeyPairNotFoundError();

    @Message(id = 141, value = "Error signing REDIRECT binding message")
    RuntimeException samlHandlerSigningRedirectBindingMessageError(@Cause Throwable t);

    @Message(id = 142, value = "Signature Validation failed")
    SignatureValidationException signatureValidationFailed();

    @Message(id = 143, value = "Invalid signature")
    ProcessingException samlHandlerInvalidSignatureError();

    @Message(id = 144, value = "Signature Validation failed. Signature is not present. Check if the IDP is supporting signatures.")
    ProcessingException samlHandlerSignatureNorPresentError();

    @Message(id = 145, value = "Signature Validation failed")
    ProcessingException samlHandlerSignatureValidationError(@Cause Throwable t);

    @Message(id = 146, value = "Error during processing the SAML Handler Chain.")
    RuntimeException samlHandlerChainProcessingError(@Cause Throwable t);

    @Message(id = 147, value = "Failed to create principal")
    LoginException authFailedToCreatePrincipal(@Cause Throwable t);

    @Message(id = 148, value = "Shared credential is not a SAML credential. Got %s")
    LoginException authSharedCredentialIsNotSAMLCredential(String className);

    @Message(id = 149, value = "Supplied assertion was considered invalid by the STS")
    LoginException authInvalidSAMLAssertionBySTSError();

    @Message(id = 150, value = "Failed to validate assertion using STS")
    LoginException authAssertionValidationValidationError(@Cause Throwable t);

    @Message(id = 151, value = "Null truststore for security domain : %s")
    LoginException authNullKeyStoreFromSecurityDomainError(String name);

    @Message(id = 152, value = "Null KeyStoreAlias; set 'KeyStoreAlias' in '%s' security domain configuration")
    LoginException authNullKeyStoreAliasFromSecurityDomainError(String name);

    @Message(id = 153, value = "No certificate found for alias '%s' in the '%s' security domain")
    LoginException authNoCertificateFoundForAliasError(String alias, String name);

    @Message(id = 154, value = "Invalid SAML assertion signature")
    LoginException authSAMLInvalidSignatureError();

    @Message(id = 155, value = "Assertion expired or used before its lifetime period")
    LoginException authSAMLAssertionExpiredError();

    @Message(id = 156, value = "Resource not found. Unable to load jboss-wsse.xml")
    RuntimeException jbossWSUnableToLoadJBossWSSEConfigError();

    @Message(id = 157, value = "Authorization Failed")
    RuntimeException jbossWSAuthorizationFailed();

    @Message(id = 158, value = "SamlCredential is not available in subject")
    LoginException authSAMLCredentialNotAvailable();

    @Message(id = 159, value = "Unable to instantiate handler: %s")
    RuntimeException authUnableToInstantiateHandler(String token, @Cause Throwable t);

    @Message(id = 160, value = "Unable to create SSL Socket Factory")
    RuntimeException jbossWSUnableToCreateSSLSocketFactory(@Cause Throwable t);

    @Message(id = 161, value = "We did not find SSL Socket Factory")
    RuntimeException jbossWSUnableToFindSSLSocketFactory();

    @Message(id = 162, value = "Unable to get the Identity from the subject")
    RuntimeException authUnableToGetIdentityFromSubject();

    @Message(id = 163, value = "SAML Assertion is null or empty")
    RuntimeException authSAMLAssertionNullOrEmpty();

    @Message(id = 164, value = "Unchecked and role(s) cannot be together")
    ProcessingException jbossWSUncheckedAndRolesCannotBeTogether();

    @Message(id = 165, value = "Identity Provider configuration error")
    RuntimeException samlIDPConfigurationError(@Cause Throwable t);

    @Message(id = 166, value = "Service Provider configuration error")
    RuntimeException samlSPConfigurationError(@Cause Throwable t);

    @Message(id = 167, value = "Could not find a security domain configuration. Check if it is defined in WEB-INF/jboss-web.xml or set the "
            + GeneralConstants.AUDIT_SECURITY_DOMAIN + " system property.")
    ConfigurationException auditSecurityDomainNotFound(@Cause Throwable t);

    @Message(id = 168, value = "Could not find a audit manager configuration. Location: %s")
    ConfigurationException auditAuditManagerNotFound(String location, @Cause Throwable t);

    @Message(id = 169, value = "Service Provider processing error.")
    IOException samlSPProcessingExceptionError(@Cause Throwable t);

    @Message(id = 170, value = "Invalid SAML Protocol Binding. Expected POST or REDIRECT.")
    IllegalArgumentException samlInvalidProtocolBinding();

    @Message(id = 171, value = "Service Provider configuration not found. Check if the " + GeneralConstants.CONFIGURATION
            + " parameter is defined in the handler chain config.")
    IllegalStateException samlHandlerServiceProviderConfigNotFound();

    @Message(id = 172, value = "Cache duration could not be created using '%s'. This value must be an ISO-8601 period or a numeric value representing the duration in milliseconds.")
    IllegalArgumentException samlMetaDataFailedToCreateCacheDuration(String timeValue);

    @Message(id = 173, value = "The security domain name could not be found. Check your jboss-web.xml.")
    ConfigurationException securityDomainNotFound();

    @Message(id = 174, value = "No configuration provided for the Identity Provider..")
    ConfigurationException samlMetaDataNoIdentityProviderDefined();

    @Message(id = 175, value = "No configuration provided for the Service Provider..")
    ConfigurationException samlMetaDataNoServiceProviderDefined();

    @Message(id = 176, value = "JDBC Initialization Error.")
    IllegalStateException jbdcInitializationError(@Cause Throwable throwable);

    @Message(id = 177, value = "Error Unmarshalling Token.")
    RuntimeException errorUnmarshallingToken(@Cause Throwable e);

    @Message(id = 178, value = "RuntimeException %s")
    RuntimeException runtimeException(String msg, @Cause Throwable e);

    @Message(id = 179, value = "Datasource is null.")
    IllegalStateException datasourceIsNull();

    @Message(id = 180, value = "Cannot parse: %s")
    IllegalArgumentException cannotParseParameterError(String parameterName, @Cause Throwable e);

    @Message(id = 181, value = "Cannot get free client pool key: %s")
    RuntimeException cannotGetFreeClientPoolKey(String key);
    
    @Message(id = 182, value = "Cannot get STS config by key:  %s")
    RuntimeException cannotGetSTSConfigByKey(String key);
    
    @Message(id = 183, value = "Cannot get used clients by key:  %s")
    RuntimeException cannotGetUsedClientsByKey(String key);
    
    @Message(id = 184, value = "Free pool already contains given key:  %s")
    RuntimeException freePoolAlreadyContainsGivenKey(String key);
    
    @Message(id = 185, value = "removing non existing client from used clients by key: %s")
    RuntimeException removingNonExistingClientFromUsedClientsByKey(String key); 
    
    @Message(id = 186, value = "Pool reached miximum number of clients within the pool (%s)")
    RuntimeException maximumNumberOfClientsReachedforPool(String max); 
    
    @Message(id = 187, value = "Wrong metadata root element should be EntitiesDescriptor or EntityDescriptor.")
    ConfigurationException wrongMetadataRootElement();
}