de.smartics.exceptions.sample.lib.resource

Class ResourceMessage.Factory

java.lang.Object

de.smartics.exceptions.sample.lib.resource.ResourceMessage.Factory

Enclosing class:

ResourceMessage

public static final class ResourceMessage.Factory
extends Object

Factory to create log messages for a given service.

Implementation Notes:

This is a factory where we configure a base set of information and only add those to the construction calls that changes. In our scenarios we use the factory to create logging event. As you can see in ResourceService we have a static factory:

private
      static final ResourceMessage.Factory MSG = new
      ResourceMessage.Factory(NAME);

Field Summary

Fields

Modifier and Type	Field and Description
private String	serviceName The name of the service to log for.

Constructor Summary

Constructors

Constructor and Description
ResourceMessage.Factory(String serviceName) Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
String	log(AnyServiceCode code, String resourceId) Factory method to create a log message instance.
String	log(AnyServiceCode code, String resourceId, Object resourceData) Factory method to create a log message instance.
ResourceMessage	msg(AnyServiceCode code, String resourceId) Factory method to create a log message instance.
ResourceMessage	msg(AnyServiceCode code, String resourceId, Object resourceData) Factory method to create a log message instance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

serviceName

private final String serviceName

The name of the service to log for.

Constructor Detail

ResourceMessage.Factory

public ResourceMessage.Factory(String serviceName)
                        throws NullPointerException,
                               IllegalArgumentException

Default constructor.

Parameters:

serviceName - the name of the service to log for.

Throws:

NullPointerException - if serviceName is null.

IllegalArgumentException - if serviceName is blank.

Method Detail

msg

public ResourceMessage msg(AnyServiceCode code,
                  String resourceId)

Factory method to create a log message instance.

Parameters:

code - the error or exception code of the exception.

resourceId - the identifier of the resource.

Returns:

the created message instance.

msg

public ResourceMessage msg(AnyServiceCode code,
                  String resourceId,
                  Object resourceData)

Factory method to create a log message instance.

Parameters:

code - the error or exception code of the exception.

resourceId - the identifier of the resource.

resourceData - the optional resource data.

Returns:

the created message instance.

log

public String log(AnyServiceCode code,
         String resourceId)

Factory method to create a log message instance.

Parameters:

code - the error or exception code of the exception.

resourceId - the identifier of the resource.

Returns:

the created message instance.

log

public String log(AnyServiceCode code,
         String resourceId,
         Object resourceData)

Factory method to create a log message instance.

Parameters:

code - the error or exception code of the exception.

resourceId - the identifier of the resource.

resourceData - the optional resource data.

Returns:

the created message instance.