info.soaj.core.attribute
Class SjAttributesForThrowable

java.lang.Object
  info.soaj.core.attribute.SjAttributesForThrowable

All Implemented Interfaces:

java.io.Serializable

public class SjAttributesForThrowable
extends java.lang.Object
implements java.io.Serializable

This immutable attributes class provides exception throwing support. It contains values assigned programmaticaly.

The "Builder" pattern as documented by Joshua Bloch ("Effective Java" - Second Edition) is utilized to handle the variable number of required and optional parameters.

Copyright (c) 2006 - 2009 by Global Technology Consulting Group, Inc. at gtcGroup.com .

Since:

v. 1.0

Author:

MarvinToll@gtcGroup.com

See Also:

Serialized Form

Nested Class Summary

static class

SjAttributesForThrowable.BuilderThrowable This static member immutable class is used to implement the builder pattern.

Field Summary

protected SjPopulatedClassName	classname The name of class throwing the exception.
protected java.lang.String	emailBCC A comma delimited list of blind carbon copy recipients.
protected java.lang.String	emailCC A comma delimited list of carbon copy email recipients.
protected java.lang.String	emailContentType The content type.
protected java.lang.String	emailFromAddress The sender's email address.
protected java.lang.String	emailMessage The email message.
protected java.lang.String	emailRecipients A comma delimited list of email recipients.
protected java.lang.String	emailSmtpHost The SMTP host name.
protected java.lang.String	emailSmtpPassword The SMTP host password.
protected java.lang.String	emailSmtpPort The SMTP host port.
protected java.lang.String	emailSmtpUserName The SMTP host user name.
protected java.lang.String	emailSocksProxyAddress The socks address.
protected java.lang.String	emailSocksProxyPort The socks proxy port.
protected java.lang.String	emailSubject The subject.
protected boolean	forceEmailingOnly Forces emailing to occur even if the exception was previously logged; default is false.
protected boolean	forceLiteLoggingOnly Forces "lite logging" (very limited stack trace) even if the exception was previously logged; default is false.
protected boolean	forceLoggingOnly Forces logging to occur even if the exception was previously logged; default is false.
protected SjPopulatedMethodName	methodname The name of method throwing the exception.
private static long	serialVersionUID UID
protected boolean	suppressEmailingOnly Suppresses emailing; default is false.
protected boolean	suppressLoggingOnly Suppresses logging; default is false.

Constructor Summary

private

SjAttributesForThrowable(SjAttributesForThrowable.BuilderThrowable builderThrowable) Constructor - private

Method Summary

boolean	containsAuthentication() This method determines whether the attribute is null.
boolean	containsEmailBCC() This method determines whether the attribute is null.
boolean	containsEmailCC() This method determines whether the attribute is null.
boolean	containsEmailContentType() This method determines whether the attribute is null.
boolean	containsEmailFromAddress() This method determines whether the attribute is null.
boolean	containsEmailMessage() This method determines whether the attribute is null.
boolean	containsEmailRecipients() This method determines whether the attribute is null.
boolean	containsEmailSmtpHost() This method determines whether the attribute is null.
boolean	containsEmailSmtpPassword() This method determines whether the attribute is null.
boolean	containsEmailSmtpPort() This method determines whether the attribute is null.
boolean	containsEmailSmtpUserName() This method determines whether the attribute is null.
boolean	containsEmailSocksProxyAddress() This method determines whether the attribute is null.
boolean	containsEmailSocksProxyPort() This method determines whether the attribute is null.
boolean	containsEmailSubject() This method determines whether the attribute is null.
java.lang.String	getClassname() This method returns an attribute.
java.lang.String	getEmailBCC() This method returns an attribute.
java.lang.String	getEmailCC() This method returns an attribute.
java.lang.String	getEmailContentType() This method returns an attribute.
java.lang.String	getEmailFromAddress() This method returns an attribute.
java.lang.String	getEmailMessage() This method returns an attribute.
java.lang.String	getEmailRecipients() This method returns an attribute.
java.lang.String	getEmailSmtpHost() This method returns an attribute.
java.lang.String	getEmailSmtpPassword() This method returns an attribute.
java.lang.String	getEmailSmtpPort() This method returns an attribute.
java.lang.String	getEmailSmtpUserName() This method returns an attribute.
java.lang.String	getEmailSocksProxyAddress() This method returns an attribute.
java.lang.String	getEmailSocksProxyPort() This method returns an attribute.
java.lang.String	getEmailSubject() This method returns an attribute.
java.lang.String	getMethodname() This method returns an attribute.
boolean	isEmailingAndLoggingSuppressed() This method returns an attribute.
boolean	isEmailingOnlyForced() This method returns an attribute.
boolean	isEmailingOrLoggingForced() This method returns an attribute.
boolean	isEmailingOrLoggingSuppressed() This method renders a verdict.
boolean	isEmailingSuppressed() This method returns an attribute.
boolean	isLiteLoggingForced() This method returns an attribute.
boolean	isLoggingOnlyForced() This method returns an attribute.
boolean	isLoggingSuppressed() This method returns an attribute.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

UID

See Also:

Constant Field Values

classname

protected final SjPopulatedClassName classname

The name of class throwing the exception.

methodname

protected final SjPopulatedMethodName methodname

The name of method throwing the exception.

suppressLoggingOnly

protected final boolean suppressLoggingOnly

Suppresses logging; default is false.

suppressEmailingOnly

protected final boolean suppressEmailingOnly

Suppresses emailing; default is false.

forceLiteLoggingOnly

protected final boolean forceLiteLoggingOnly

Forces "lite logging" (very limited stack trace) even if the exception was previously logged; default is false.

forceLoggingOnly

protected final boolean forceLoggingOnly

Forces logging to occur even if the exception was previously logged; default is false.

forceEmailingOnly

protected final boolean forceEmailingOnly

Forces emailing to occur even if the exception was previously logged; default is false.

emailMessage

protected final java.lang.String emailMessage

The email message.

emailSubject

protected final java.lang.String emailSubject

The subject.

emailRecipients

protected final java.lang.String emailRecipients

A comma delimited list of email recipients.

emailCC

protected final java.lang.String emailCC

A comma delimited list of carbon copy email recipients.

emailBCC

protected final java.lang.String emailBCC

A comma delimited list of blind carbon copy recipients.

emailFromAddress

protected final java.lang.String emailFromAddress

The sender's email address.

emailContentType

protected final java.lang.String emailContentType

The content type.

emailSmtpHost

protected final java.lang.String emailSmtpHost

The SMTP host name.

emailSmtpUserName

protected final java.lang.String emailSmtpUserName

The SMTP host user name.

emailSmtpPassword

protected final java.lang.String emailSmtpPassword

The SMTP host password.

emailSmtpPort

protected final java.lang.String emailSmtpPort

The SMTP host port.

emailSocksProxyAddress

protected final java.lang.String emailSocksProxyAddress

The socks address.

emailSocksProxyPort

protected final java.lang.String emailSocksProxyPort

The socks proxy port.

Constructor Detail

SjAttributesForThrowable

private SjAttributesForThrowable(SjAttributesForThrowable.BuilderThrowable builderThrowable)

Constructor - private

Parameters:

builderThrowable -

Method Detail

getClassname

public java.lang.String getClassname()

This method returns an attribute.

Returns:

String - Returns the classname attribute.

getMethodname

public java.lang.String getMethodname()

This method returns an attribute.

Returns:

String - Returns the methodname attribute.

isEmailingSuppressed

public boolean isEmailingSuppressed()

This method returns an attribute.

Returns:

boolean - Returns the suppressEmailingOnly attribute.

isLoggingSuppressed

public boolean isLoggingSuppressed()

This method returns an attribute.

Returns:

boolean - Returns the suppressLoggingOnly attribute.

isEmailingAndLoggingSuppressed

public boolean isEmailingAndLoggingSuppressed()

This method returns an attribute.

Returns:

boolean

isEmailingOrLoggingSuppressed

public boolean isEmailingOrLoggingSuppressed()

This method renders a verdict.

Returns:

boolean

isLiteLoggingForced

public boolean isLiteLoggingForced()

This method returns an attribute.

Returns:

boolean - Returns the forceLiteLoggingOnly attribute.

isLoggingOnlyForced

public boolean isLoggingOnlyForced()

This method returns an attribute.

Returns:

boolean - Returns the forceEmailingAndLogging attribute.

isEmailingOnlyForced

public boolean isEmailingOnlyForced()

This method returns an attribute.

Returns:

boolean - Returns the forceEmailingAndLogging attribute.

isEmailingOrLoggingForced

public boolean isEmailingOrLoggingForced()

This method returns an attribute.

Returns:

boolean

containsAuthentication

public boolean containsAuthentication()

This method determines whether the attribute is null.

Returns:

boolean

containsEmailBCC

public boolean containsEmailBCC()

This method determines whether the attribute is null.

Returns:

boolean

getEmailBCC

public java.lang.String getEmailBCC()

This method returns an attribute.

Returns:

String - Returns the emailBCC attribute.

containsEmailCC

public boolean containsEmailCC()

This method determines whether the attribute is null.

Returns:

boolean

getEmailCC

public java.lang.String getEmailCC()

This method returns an attribute.

Returns:

String - Returns the emailCC attribute.

containsEmailRecipients

public boolean containsEmailRecipients()

This method determines whether the attribute is null.

Returns:

boolean

getEmailRecipients

public java.lang.String getEmailRecipients()

This method returns an attribute.

Returns:

String - Returns the emailRecipients attribute.

containsEmailContentType

public boolean containsEmailContentType()

This method determines whether the attribute is null.

Returns:

boolean

getEmailContentType

public java.lang.String getEmailContentType()

This method returns an attribute.

Returns:

String - Returns the emailContentType attribute.

containsEmailFromAddress

public boolean containsEmailFromAddress()

This method determines whether the attribute is null.

Returns:

boolean

getEmailFromAddress

public java.lang.String getEmailFromAddress()

This method returns an attribute.

Returns:

String - Returns the emailFromAddress attribute.

containsEmailMessage

public boolean containsEmailMessage()

This method determines whether the attribute is null.

Returns:

boolean

getEmailMessage

public java.lang.String getEmailMessage()

This method returns an attribute.

Returns:

String - Returns the emailMessageAppended attribute.

containsEmailSmtpPassword

public boolean containsEmailSmtpPassword()

This method determines whether the attribute is null.

Returns:

boolean

getEmailSmtpPassword

public java.lang.String getEmailSmtpPassword()

This method returns an attribute.

Returns:

String - Returns the emailSmtpPassword attribute.

containsEmailSmtpHost

public boolean containsEmailSmtpHost()

This method determines whether the attribute is null.

Returns:

boolean

getEmailSmtpHost

public java.lang.String getEmailSmtpHost()

This method returns an attribute.

Returns:

String - Returns the emailSmtpHost attribute.

containsEmailSmtpPort

public boolean containsEmailSmtpPort()

This method determines whether the attribute is null.

Returns:

boolean

getEmailSmtpPort

public java.lang.String getEmailSmtpPort()

This method returns an attribute.

Returns:

String - Returns the emailSmtpPort attribute.

containsEmailSubject

public boolean containsEmailSubject()

This method determines whether the attribute is null.

Returns:

boolean

getEmailSubject

public java.lang.String getEmailSubject()

This method returns an attribute.

Returns:

String - Returns the emailSubject attribute.

containsEmailSmtpUserName

public boolean containsEmailSmtpUserName()

This method determines whether the attribute is null.

Returns:

boolean

getEmailSmtpUserName

public java.lang.String getEmailSmtpUserName()

This method returns an attribute.

Returns:

String - Returns the emailSmtpUserName attribute.

containsEmailSocksProxyAddress

public boolean containsEmailSocksProxyAddress()

This method determines whether the attribute is null.

Returns:

boolean

getEmailSocksProxyAddress

public java.lang.String getEmailSocksProxyAddress()

This method returns an attribute.

Returns:

String - Returns the emailSocksProxyAddress attribute.

containsEmailSocksProxyPort

public boolean containsEmailSocksProxyPort()

This method determines whether the attribute is null.

Returns:

boolean

getEmailSocksProxyPort

public java.lang.String getEmailSocksProxyPort()

This method returns an attribute.

Returns:

String - Returns the emailSocksProxyPort attribute.