Interface PicketLinkLogger

  • All Known Implementing Classes:
    DefaultPicketLinkLogger

    public interface PicketLinkLogger

    This interface acts as a Log Facade for PicketLink, from which exceptions and messages should be created or logged.

    As PicketLink supports multiple containers and its versions, the main objective of this interface is to abstract the logging aspects from the code and provide different logging implementations for each supported binding/container.

    Author:
    Pedro Silva
    • Method Detail

      • isInfoEnabled

        boolean isInfoEnabled()

        Indicates if the logging level is set to INFO.

        Returns:
      • auditEvent

        void auditEvent​(String auditEvent)

        Logs a PicketLink Audit Event.

        Parameters:
        auditEvent -
      • keyStoreSetup

        void keyStoreSetup()

        Logs a message during the KeyStore setup.

      • keyStoreNullPublicKeyForAlias

        void keyStoreNullPublicKeyForAlias​(String alias)

        Logs a message for the cases where no public key was found for a given alias.

        Parameters:
        alias -
      • keyStoreNullSigningKeyPass

        RuntimeException keyStoreNullSigningKeyPass()

        Creates a RuntimeException for the case where the signing key password is null.

        Returns:
      • keyStoreNullEncryptionKeyPass

        RuntimeException keyStoreNullEncryptionKeyPass()
      • parserUnknownEndElement

        RuntimeException parserUnknownEndElement​(String endElementName,
                                                 Location location)

        Creates a RuntimeException for the case where parser founds a unknown end element.

        Parameters:
        endElementName -
        Returns:
      • parserRequiredAttribute

        ParsingException parserRequiredAttribute​(String string)
        Parameters:
        string -
        Returns:
      • parserUnknownStartElement

        RuntimeException parserUnknownStartElement​(String elementName,
                                                   Location location)
        Parameters:
        elementName -
        location -
        Returns:
      • parserUnknownXSI

        ParsingException parserUnknownXSI​(String xsiTypeValue)
        Parameters:
        xsiTypeValue -
        Returns:
      • parserExpectedEndTag

        ParsingException parserExpectedEndTag​(String tagName)
        Parameters:
        string -
        Returns:
      • parserExpectedTextValue

        ParsingException parserExpectedTextValue​(String string)
        Parameters:
        string -
        Returns:
      • parserExpectedXSI

        RuntimeException parserExpectedXSI​(String expectedXsi)
        Parameters:
        expectedXsi -
        Returns:
      • parserExpectedTag

        RuntimeException parserExpectedTag​(String tag,
                                           String foundElementTag)
        Parameters:
        tag -
        foundElementTag -
        Returns:
      • parserExpectedNamespace

        RuntimeException parserExpectedNamespace​(String ns,
                                                 String foundElementNs)
        Parameters:
        ns -
        foundElementNs -
        Returns:
      • parserUnableParsingNullToken

        ParsingException parserUnableParsingNullToken()
        Returns:
      • stsTokenRegistryNotSpecified

        void stsTokenRegistryNotSpecified()
      • stsTokenRegistryInvalidType

        void stsTokenRegistryInvalidType​(String tokenRegistryOption)
        Parameters:
        tokenRegistryOption -
      • stsTokenRegistryInstantiationError

        void stsTokenRegistryInstantiationError()
      • stsRevocationRegistryNotSpecified

        void stsRevocationRegistryNotSpecified()
      • stsRevocationRegistryInvalidType

        void stsRevocationRegistryInvalidType​(String registryOption)
        Parameters:
        registryOption -
      • stsRevocationRegistryInstantiationError

        void stsRevocationRegistryInstantiationError()
      • writerUnknownTypeError

        RuntimeException writerUnknownTypeError​(String name)
        Parameters:
        name -
        Returns:
      • writerUnsupportedAttributeValueError

        RuntimeException writerUnsupportedAttributeValueError​(String value)
        Parameters:
        value -
        Returns:
      • systemPropertyMissingError

        RuntimeException systemPropertyMissingError​(String property)
        Parameters:
        property -
        Returns:
      • samlMetaDataIdentityProviderLoadingError

        void samlMetaDataIdentityProviderLoadingError​(Throwable t)
        Parameters:
        t -
      • samlMetaDataServiceProviderLoadingError

        void samlMetaDataServiceProviderLoadingError​(Throwable t)
        Parameters:
        t -
      • signatureAssertionValidationError

        void signatureAssertionValidationError​(Throwable t)
        Parameters:
        t -
      • samlAssertionExpired

        void samlAssertionExpired​(String id)
        Parameters:
        id -
      • unknownObjectType

        RuntimeException unknownObjectType​(Object attrValue)
        Parameters:
        attrValue -
        Returns:
      • trace

        void trace​(String message)
        Parameters:
        message -
      • trace

        void trace​(String message,
                   Throwable t)
        Parameters:
        string -
        t -
      • stsNoTokenProviderError

        ProcessingException stsNoTokenProviderError​(String configuration,
                                                    String protocolContext)
        Parameters:
        configuration -
        protocolContext -
        Returns:
      • debug

        void debug​(String message)
        Parameters:
        message -
      • stsConfigurationFileNotFoundTCL

        void stsConfigurationFileNotFoundTCL​(String fileName)
        Parameters:
        fileName -
      • stsConfigurationFileNotFoundClassLoader

        void stsConfigurationFileNotFoundClassLoader​(String fileName)
        Parameters:
        fileName -
      • stsUsingDefaultConfiguration

        void stsUsingDefaultConfiguration​(String fileName)
        Parameters:
        fileName -
      • stsConfigurationFileLoaded

        void stsConfigurationFileLoaded​(String fileName)
        Parameters:
        fileName -
      • notSerializableError

        IOException notSerializableError​(String message)
        Parameters:
        message -
        Returns:
      • trustKeyManagerCreationError

        void trustKeyManagerCreationError​(Throwable t)
      • info

        void info​(String message)
        Parameters:
        message -
      • warn

        void warn​(String message)
        Parameters:
        string -
      • error

        void error​(String message)
        Parameters:
        message -
      • xmlCouldNotGetSchema

        void xmlCouldNotGetSchema​(Throwable t)
        Parameters:
        t -
      • isTraceEnabled

        boolean isTraceEnabled()
        Returns:
      • isDebugEnabled

        boolean isDebugEnabled()
        Returns:
      • jceProviderCouldNotBeLoaded

        void jceProviderCouldNotBeLoaded​(String name,
                                         Throwable t)
        Parameters:
        name -
        t -
      • writerInvalidKeyInfoNullContentError

        ProcessingException writerInvalidKeyInfoNullContentError()
        Returns:
      • encryptUnknownAlgoError

        RuntimeException encryptUnknownAlgoError​(String certAlgo)
        Parameters:
        certAlgo -
        Returns:
      • stsWSInvalidTokenRequestError

        javax.xml.ws.WebServiceException stsWSInvalidTokenRequestError()
        Returns:
      • stsWSError

        javax.xml.ws.WebServiceException stsWSError​(Throwable t)
        Parameters:
        t -
        Returns:
      • stsWSConfigurationError

        javax.xml.ws.WebServiceException stsWSConfigurationError​(Throwable t)
        Parameters:
        t -
        Returns:
      • stsWSInvalidRequestTypeError

        WSTrustException stsWSInvalidRequestTypeError​(String requestType)
        Parameters:
        requestType -
        Returns:
      • stsWSHandlingTokenRequestError

        javax.xml.ws.WebServiceException stsWSHandlingTokenRequestError​(Throwable t)
        Parameters:
        t -
        Returns:
      • stsWSResponseWritingError

        javax.xml.ws.WebServiceException stsWSResponseWritingError​(Throwable t)
        Parameters:
        t -
        Returns:
      • stsUnableToConstructKeyManagerError

        RuntimeException stsUnableToConstructKeyManagerError​(Throwable t)
        Parameters:
        t -
        Returns:
      • stsTokenTimeoutNotSpecified

        void stsTokenTimeoutNotSpecified()
      • wsTrustClientPublicKeyError

        WSTrustException wsTrustClientPublicKeyError()
        Returns:
      • stsSecurityTokenSignatureNotVerified

        void stsSecurityTokenSignatureNotVerified()
      • stsSecurityTokenShouldBeEncrypted

        void stsSecurityTokenShouldBeEncrypted()
      • unableToDecodePasswordError

        RuntimeException unableToDecodePasswordError​(String password)
        Parameters:
        password -
        Returns:
      • stsSecretKeyNotEncrypted

        void stsSecretKeyNotEncrypted()
      • authCouldNotIssueSAMLToken

        LoginException authCouldNotIssueSAMLToken()
        Returns:
      • samlAssertionWithoutExpiration

        void samlAssertionWithoutExpiration​(String id)
        Parameters:
        id -
      • authCouldNotValidateSAMLToken

        LoginException authCouldNotValidateSAMLToken​(Element token)
        Parameters:
        token -
        Returns:
      • authCouldNotLocateSecurityToken

        LoginException authCouldNotLocateSecurityToken()
        Returns:
      • wsTrustNullValidationTargetError

        ProcessingException wsTrustNullValidationTargetError()
        Returns:
      • stsWrongAttributeProviderTypeNotInstalled

        void stsWrongAttributeProviderTypeNotInstalled​(String attributeProviderClassName)
        Parameters:
        attributeProviderClassName -
      • attributeProviderInstationError

        void attributeProviderInstationError​(Throwable t)
        Parameters:
        t -
      • samlAssertion

        void samlAssertion​(String nodeAsString)
        Parameters:
        nodeAsString -
      • wsTrustUnableToGetDataTypeFactory

        RuntimeException wsTrustUnableToGetDataTypeFactory​(Throwable t)
        Parameters:
        dce -
        Returns:
      • wsTrustValidationStatusCodeMissing

        ProcessingException wsTrustValidationStatusCodeMissing()
        Returns:
      • samlIdentityServerActiveSessionCount

        void samlIdentityServerActiveSessionCount​(int activeSessionCount)
        Parameters:
        activeSessionCount -
      • samlIdentityServerSessionCreated

        void samlIdentityServerSessionCreated​(String id,
                                              int activeSessionCount)
        Parameters:
        id -
        activeSessionCount -
      • samlIdentityServerSessionDestroyed

        void samlIdentityServerSessionDestroyed​(String id,
                                                int activeSessionCount)
        Parameters:
        id -
        activeSessionCount -
      • samlHandlerRoleGeneratorSetupError

        void samlHandlerRoleGeneratorSetupError​(Throwable t)
        Parameters:
        t -
      • samlHandlerAssertionNotFound

        RuntimeException samlHandlerAssertionNotFound()
        Returns:
      • samlHandlerAuthenticationError

        void samlHandlerAuthenticationError​(Throwable t)
        Parameters:
        t -
      • samlHandlerNullEncryptedAssertion

        ProcessingException samlHandlerNullEncryptedAssertion()
        Returns:
      • samlHandlerIDPAuthenticationFailedError

        SecurityException samlHandlerIDPAuthenticationFailedError()
        Returns:
      • unsupportedRoleType

        RuntimeException unsupportedRoleType​(Object attrValue)
        Parameters:
        attrValue -
        Returns:
      • samlHandlerFailedInResponseToVerification

        void samlHandlerFailedInResponseToVerification​(String inResponseTo,
                                                       String authnRequestId)
        Parameters:
        inResponseTo -
        authnRequestId -
      • samlHandlerFailedInResponseToVerificarionError

        ProcessingException samlHandlerFailedInResponseToVerificarionError()
        Returns:
      • samlHandlerIdentityServerNotFoundError

        ProcessingException samlHandlerIdentityServerNotFoundError()
        Returns:
      • samlHandlerPrincipalNotFoundError

        ProcessingException samlHandlerPrincipalNotFoundError()
        Returns:
      • samlHandlerKeyPairNotFound

        void samlHandlerKeyPairNotFound()
      • samlHandlerKeyPairNotFoundError

        ProcessingException samlHandlerKeyPairNotFoundError()
        Returns:
      • samlHandlerErrorSigningRedirectBindingMessage

        void samlHandlerErrorSigningRedirectBindingMessage​(Throwable t)
        Parameters:
        t -
      • samlHandlerSigningRedirectBindingMessageError

        RuntimeException samlHandlerSigningRedirectBindingMessageError​(Throwable t)
        Parameters:
        t -
        Returns:
      • samlHandlerErrorValidatingSignature

        void samlHandlerErrorValidatingSignature​(Throwable t)
        Parameters:
        t -
      • samlHandlerInvalidSignatureError

        ProcessingException samlHandlerInvalidSignatureError()
        Returns:
      • samlHandlerSignatureNotPresentError

        ProcessingException samlHandlerSignatureNotPresentError()
        Returns:
      • error

        void error​(Throwable t)
        Parameters:
        t -
      • samlHandlerChainProcessingError

        RuntimeException samlHandlerChainProcessingError​(Throwable t)
        Parameters:
        t -
        Returns:
      • samlBase64DecodingError

        void samlBase64DecodingError​(Throwable t)
        Parameters:
        rte -
      • samlParsingError

        void samlParsingError​(Throwable t)
        Parameters:
        t -
      • trace

        void trace​(Throwable t)
        Parameters:
        t -
      • mappingContextNull

        void mappingContextNull()
      • attributeManagerError

        void attributeManagerError​(Throwable t)
        Parameters:
        t -
      • couldNotObtainSecurityContext

        void couldNotObtainSecurityContext()
      • authFailedToCreatePrincipal

        LoginException authFailedToCreatePrincipal​(Throwable t)
        Parameters:
        t -
        Returns:
      • authSharedCredentialIsNotSAMLCredential

        LoginException authSharedCredentialIsNotSAMLCredential​(String className)
        Parameters:
        class1 -
        Returns:
      • authSTSConfigFileNotFound

        LoginException authSTSConfigFileNotFound()
        Returns:
      • authInvalidSAMLAssertionBySTS

        LoginException authInvalidSAMLAssertionBySTS()
        Returns:
      • authAssertionValidationError

        LoginException authAssertionValidationError​(Throwable t)
        Parameters:
        t -
        Returns:
      • authFailedToParseSAMLAssertion

        LoginException authFailedToParseSAMLAssertion​(Throwable t)
        Parameters:
        t -
        Returns:
      • samlAssertionPasingFailed

        void samlAssertionPasingFailed​(Throwable t)
        Parameters:
        t -
      • authNullKeyStoreFromSecurityDomainError

        LoginException authNullKeyStoreFromSecurityDomainError​(String name)
      • authNullKeyStoreAliasFromSecurityDomainError

        LoginException authNullKeyStoreAliasFromSecurityDomainError​(String name)
      • authSAMLInvalidSignatureError

        LoginException authSAMLInvalidSignatureError()
      • authSAMLAssertionExpiredError

        LoginException authSAMLAssertionExpiredError()
      • authSAMLAssertionIssuingFailed

        void authSAMLAssertionIssuingFailed​(Throwable t)
        Parameters:
        t -
      • jbossWSUnableToCreateBinaryToken

        void jbossWSUnableToCreateBinaryToken​(Throwable t)
        Parameters:
        t -
      • jbossWSUnableToCreateSecurityToken

        void jbossWSUnableToCreateSecurityToken()
      • jbossWSUnableToWriteSOAPMessage

        void jbossWSUnableToWriteSOAPMessage​(Throwable t)
        Parameters:
        ignore -
      • jbossWSUnableToLoadJBossWSSEConfigError

        RuntimeException jbossWSUnableToLoadJBossWSSEConfigError()
        Returns:
      • jbossWSAuthorizationFailed

        RuntimeException jbossWSAuthorizationFailed()
        Returns:
      • jbossWSErrorGettingOperationName

        void jbossWSErrorGettingOperationName​(Throwable t)
        Parameters:
        t -
      • authSAMLCredentialNotAvailable

        LoginException authSAMLCredentialNotAvailable()
        Returns:
      • jbossWSUnableToCreateSSLSocketFactory

        RuntimeException jbossWSUnableToCreateSSLSocketFactory​(Throwable t)
        Parameters:
        e1 -
        Returns:
      • jbossWSUnableToFindSSLSocketFactory

        RuntimeException jbossWSUnableToFindSSLSocketFactory()
        Returns:
      • authUnableToGetIdentityFromSubject

        RuntimeException authUnableToGetIdentityFromSubject()
        Returns:
      • authSAMLAssertionNullOrEmpty

        RuntimeException authSAMLAssertionNullOrEmpty()
        Returns:
      • jbossWSUncheckedAndRolesCannotBeTogether

        ProcessingException jbossWSUncheckedAndRolesCannotBeTogether()
        Returns:
      • samlIDPHandlingSAML11Error

        void samlIDPHandlingSAML11Error​(Throwable t)
        Parameters:
        t -
      • samlIDPRequestProcessingError

        void samlIDPRequestProcessingError​(Throwable t)
        Parameters:
        t -
      • samlIDPUnableToSetParticipantStackUsingDefault

        void samlIDPUnableToSetParticipantStackUsingDefault​(Throwable t)
        Parameters:
        t -
      • samlHandlerConfigurationError

        void samlHandlerConfigurationError​(Throwable t)
        Parameters:
        t -
      • samlIDPSettingCanonicalizationMethod

        void samlIDPSettingCanonicalizationMethod​(String canonicalizationMethod)
        Parameters:
        canonicalizationMethod -
      • configurationFileMissing

        RuntimeException configurationFileMissing​(String configFile)
        Parameters:
        configFile -
        Returns:
      • samlIDPInstallingDefaultSTSConfig

        void samlIDPInstallingDefaultSTSConfig()
      • samlSPFallingBackToLocalFormAuthentication

        void samlSPFallingBackToLocalFormAuthentication()
      • unableLocalAuthentication

        IOException unableLocalAuthentication​(Throwable t)
        Parameters:
        ex -
        Returns:
      • samlSPUnableToGetIDPDescriptorFromMetadata

        void samlSPUnableToGetIDPDescriptorFromMetadata()
      • samlSPSettingCanonicalizationMethod

        void samlSPSettingCanonicalizationMethod​(String canonicalizationMethod)
        Parameters:
        canonicalizationMethod -
      • samlSPCouldNotDispatchToLogoutPage

        void samlSPCouldNotDispatchToLogoutPage​(String logOutPage)
        Parameters:
        logOutPage -
      • usingLoggerImplementation

        void usingLoggerImplementation​(String className)

        Logs the implementation being used to log messages and exceptions.

        Parameters:
        name -
      • samlResponseFromIDPParsingFailed

        void samlResponseFromIDPParsingFailed()
      • samlSPResponseNotCatalinaResponseError

        RuntimeException samlSPResponseNotCatalinaResponseError​(Object response)
        Parameters:
        response -
        Returns:
      • samlLogoutError

        void samlLogoutError​(Throwable t)
        Parameters:
        t -
      • samlErrorPageForwardError

        void samlErrorPageForwardError​(String errorPage,
                                       Throwable t)
        Parameters:
        t -
      • samlSPHandleRequestError

        void samlSPHandleRequestError​(Throwable t)
        Parameters:
        t -
      • samlSPProcessingExceptionError

        IOException samlSPProcessingExceptionError​(Throwable t)
        Parameters:
        t -
        Returns:
      • samlHandlerServiceProviderConfigNotFound

        IllegalStateException samlHandlerServiceProviderConfigNotFound()
        Returns:
      • samlSecurityTokenAlreadyPersisted

        void samlSecurityTokenAlreadyPersisted​(String id)
      • samlSecurityTokenNotFoundInRegistry

        void samlSecurityTokenNotFoundInRegistry​(String id)
        Parameters:
        id -
      • removingNonExistingClientFromUsedClientsByKey

        RuntimeException removingNonExistingClientFromUsedClientsByKey​(String key)