Interface Log

  • All Superinterfaces:
    org.jboss.logging.BasicLogger
    All Known Implementing Classes:
    Log_$logger

    @MessageLogger(projectCode="ISPN")
    public interface Log
    extends org.jboss.logging.BasicLogger
    Infinispan's log abstraction layer on top of JBoss Logging.

    It contains explicit methods for all INFO or above levels so that they can be internationalized. For the commons module, message ids ranging from 0901 to 1000 inclusively have been reserved.

    Log log = LogFactory.getLog( getClass() ); The above will get you an instance of Log, which can be used to generate log messages either via JBoss Logging which then can delegate to Log4J (if the libraries are present) or (if not) the built-in JDK logger.

    In addition to the 6 log levels available, this framework also supports parameter interpolation, similar to the JDKs String.format(String, Object...) method. What this means is, that the following block: if (log.isTraceEnabled()) { log.trace("This is a message " + message + " and some other value is " + value); }

    ... could be replaced with ...

    if (log.isTraceEnabled()) log.tracef("This is a message %s and some other value is %s", message, value);

    This greatly enhances code readability.

    If you are passing a Throwable, note that this should be passed in before the vararg parameter list.

    Since:
    4.0
    Author:
    Manik Surtani
    • Method Detail

      • propertyCouldNotBeReplaced

        @LogMessage(level=WARN)
        @Message(value="Property %s could not be replaced as intended!",
                 id=901)
        void propertyCouldNotBeReplaced​(String line)
      • ignoringException

        @LogMessage(level=WARN)
        @Message(value="Invocation of %s threw an exception %s. Exception is ignored.",
                 id=902)
        void ignoringException​(String methodName,
                               String exceptionName,
                               @Cause
                               Throwable t)
      • unableToLoadClass

        @LogMessage(level=ERROR)
        @Message(value="Unable to load %s from any of the following classloaders: %s",
                 id=905)
        void unableToLoadClass​(String classname,
                               String classloaders,
                               @Cause
                               Throwable cause)
      • unableToConvertStringPropertyToInt

        @LogMessage(level=WARN)
        @Message(value="Unable to convert string property [%s] to an int! Using default value of %d",
                 id=906)
        void unableToConvertStringPropertyToInt​(String value,
                                                int defaultValue)
      • unableToConvertStringPropertyToLong

        @LogMessage(level=WARN)
        @Message(value="Unable to convert string property [%s] to a long! Using default value of %d",
                 id=907)
        void unableToConvertStringPropertyToLong​(String value,
                                                 long defaultValue)
      • unableToConvertStringPropertyToBoolean

        @LogMessage(level=WARN)
        @Message(value="Unable to convert string property [%s] to a boolean! Using default value of %b",
                 id=908)
        void unableToConvertStringPropertyToBoolean​(String value,
                                                    boolean defaultValue)
      • illegalValueThreadPoolParameter

        @Message(value="Illegal value for thread pool parameter(s) %s, it should be: %s",
                 id=910)
        CacheConfigurationException illegalValueThreadPoolParameter​(String parameter,
                                                                    String requirement)
      • unableToUnwrapAny

        @Message(value="Unwrapping of any instances in %s to a type of %s is not a supported",
                 id=911)
        IllegalArgumentException unableToUnwrapAny​(String objs,
                                                   Class<?> clazz)
      • unprotectedAttributeSet

        @Message(value="Expecting a protected configuration for %s",
                 id=912)
        IllegalStateException unprotectedAttributeSet​(String name)
      • protectedAttributeSet

        @Message(value="Expecting a unprotected configuration for %s",
                 id=913)
        IllegalStateException protectedAttributeSet​(String name)
      • attributeSetDuplicateAttribute

        @Message(value="Duplicate attribute \'%s\' in attribute set \'%s\'",
                 id=914)
        IllegalArgumentException attributeSetDuplicateAttribute​(String name,
                                                                String setName)
      • noAttributeCopierForType

        @Message(value="No attribute copier for type \'%s\'",
                 id=916)
        IllegalArgumentException noAttributeCopierForType​(Class<?> klass)
      • cannotFindResource

        @Message(value="Cannot find resource \'%s\'",
                 id=918)
        IOException cannotFindResource​(String fileName)
      • multipleConfigurationValidationErrors

        @Message(value="Multiple errors encountered while validating configuration",
                 id=919)
        CacheConfigurationException multipleConfigurationValidationErrors()
      • noSuchAliasInKeyStore

        @Message(value="The alias \'%s\' does not exist in the key store \'%s\'",
                 id=921)
        SecurityException noSuchAliasInKeyStore​(String keyAlias,
                                                String keyStoreFileName)
      • errorRollingBack

        @LogMessage(level=ERROR)
        @Message(value="Exception during rollback",
                 id=922)
        void errorRollingBack​(@Cause
                              Throwable e)
      • errorEnlistingResource

        @LogMessage(level=ERROR)
        @Message(value="Error enlisting resource",
                 id=923)
        void errorEnlistingResource​(@Cause
                                    Throwable e)
      • beforeCompletionFailed

        @LogMessage(level=ERROR)
        @Message(value="beforeCompletion() failed for %s",
                 id=924)
        void beforeCompletionFailed​(String synchronization,
                                    @Cause
                                    Throwable t)
      • unexpectedErrorFromResourceManager

        @LogMessage(level=ERROR)
        @Message(value="Unexpected error from resource manager!",
                 id=925)
        void unexpectedErrorFromResourceManager​(@Cause
                                                Throwable t)
      • afterCompletionFailed

        @LogMessage(level=ERROR)
        @Message(value="afterCompletion() failed for %s",
                 id=926)
        void afterCompletionFailed​(String synchronization,
                                   @Cause
                                   Throwable t)
      • errorCommittingTx

        @LogMessage(level=WARN)
        @Message(value="exception while committing",
                 id=927)
        void errorCommittingTx​(@Cause
                               Throwable e)
      • xaResourceEndFailed

        @LogMessage(level=ERROR)
        @Message(value="end() failed for %s",
                 id=928)
        void xaResourceEndFailed​(String xaResource,
                                 @Cause
                                 Throwable t)
      • missingMediaType

        @Message(value="MediaType cannot be empty or null!",
                 id=929)
        EncodingException missingMediaType()
      • invalidMediaTypeSubtype

        @Message(value="MediaType must contain a type and a subtype separated by \'/\'",
                 id=930)
        EncodingException invalidMediaTypeSubtype()
      • invalidMediaTypeParam

        @Message(value="Failed to parse MediaType: Invalid param description \'%s\'",
                 id=931)
        EncodingException invalidMediaTypeParam​(String param)
      • unquotedMediaTypeParam

        @Message(value="Unclosed param value quote",
                 id=932)
        EncodingException unquotedMediaTypeParam()
      • invalidCharMediaType

        @Message(value="Invalid character \'%s\' found in token \'%s\'",
                 id=933)
        EncodingException invalidCharMediaType​(char character,
                                               String token)
      • unsupportedContent

        @Message(value="Unsupported content \'%s\'",
                 id=934)
        EncodingException unsupportedContent​(Object content)
      • invalidWeight

        @Message(value="Invalid Weight \'%s\'. Supported values are between 0 and 1.0",
                 id=935)
        EncodingException invalidWeight​(Object weight)
      • classNotInWhitelist

        @Message(value="Class \'%s\' blocked by deserialization white list. Adjust the configuration serialization white list regular expression to include this class.",
                 id=936)
        CacheException classNotInWhitelist​(String className)
      • invalidMediaType

        @Message(value="Invalid media type. Expected \'%s\' but got \'%s\'",
                 id=937)
        EncodingException invalidMediaType​(String expected,
                                           String actual)
      • invalidTextContent

        @Message(value="Invalid text content \'%s\'",
                 id=938)
        EncodingException invalidTextContent​(Object content)
      • conversionNotSupported

        @Message(value="Conversion of content \'%s\' from \'%s\' to \'%s\' not supported",
                 id=939)
        EncodingException conversionNotSupported​(Object content,
                                                 String fromMediaType,
                                                 String toMediaType)
      • cannotDecodeFormURLContent

        @Message(value="Invalid application/x-www-form-urlencoded content: \'%s\'",
                 id=940)
        EncodingException cannotDecodeFormURLContent​(Object content)
      • unableToConvertStringPropertyToEnum

        @LogMessage(level=WARN)
        @Message(value="Unable to convert property [%s] to an enum! Using default value of %d",
                 id=942)
        void unableToConvertStringPropertyToEnum​(String value,
                                                 String defaultValue)
      • couldNotRegisterObjectName

        @LogMessage(level=WARN)
        @Message(value="Could not register object with name: %s",
                 id=943)
        void couldNotRegisterObjectName​(ObjectName objectName,
                                        @Cause
                                        InstanceAlreadyExistsException e)
      • invalidCounterType

        @Message(value="Invalid counter type. Expected=%s but got %s",
                 id=29514)
        CounterException invalidCounterType​(String expected,
                                            String actual)
      • undefinedCounter

        @Message(value="Counter \'%s\' is not defined.",
                 id=29516)
        CounterException undefinedCounter​(String name)
      • invalidCounterTypeEncoded

        @Message(value="WEAK and BOUNDED encoded flag isn\'t supported!",
                 id=29522)
        CounterException invalidCounterTypeEncoded()