org.miloss.fgsms.common

Class Utility

java.lang.Object

org.miloss.fgsms.common.Utility

public class Utility
extends Object

fgsms's Utility functions - Ahh the good old Utility class. containsPolicyType string functions, friendly name conversions, serialization contexts and more. This also is the place to go to for JDBC connections

Author:

AO

Field Summary

Fields

Modifier and Type	Field and Description
static String	JDBC_CONFIG
static String	JDBC_PERFORMANCE
static String	logname
static String	PropertyFilePath
static String	SECONDARY_POSTIFX

Constructor Summary

Constructors

Constructor and Description
Utility()

Method Summary

Methods

Modifier and Type	Method and Description
static void	addStatusChangeSLA(org.miloss.fgsms.services.interfaces.policyconfiguration.ServicePolicy ret) Addings the default Status Change SLA for email alerts
static boolean	containsPolicyType(List<org.miloss.fgsms.services.interfaces.common.PolicyType> appliesTo, org.miloss.fgsms.services.interfaces.common.PolicyType optionalPolicyTypeFilter) convenience method, does the list contain the policy type
static String	DE(String cipher) Decrypts a password or other sensitive data.
static String	durationLargestUnitToString(Duration d) returns just the largest unit of measure for durations up to years
static String	durationToString(Duration d) Converts a duration to 1yr 1mo 1d 1hr 1min 1s string format
static long	durationToTimeInMS(Duration d) converts a duration to time in ms
static String	EN(String clear) encrypts a password AES 256 bit Requires the Unlimited Strength Crypto Extensions
static String	encodeHTML(String s) HTML encodes strings to prevent CXS, if the parameter is an null or empty, an empty string is returned, but never null
static String	formatDateTime(Calendar cal)
static String	formatDateTime(Date cal)
static String	formatDateTime(long timestampEpoch)
static String	getActionNameFromXML(String xml) uses a variety of classes to determine the name of the first XML child node of a SOAP:envelope node
static List<org.miloss.fgsms.services.interfaces.common.PolicyType>	getAllPolicyTypes()
static JAXBContext	getARSSerializationContext() used by the Automated Reporting Service, creates a jaxb context to serialize/deserial a reporting job
static Connection	getConfigurationDB_NONPOOLED_Connection() Deprecated.
static Connection	getConfigurationDBConnection() returns a JDNI pooled database connection if the primary cannot be reached, the secondary is used or null is returned.
static String	getHostName() returns the lowercase hostname
static org.miloss.fgsms.services.interfaces.common.NameValuePair	getNameValuePairByName(List<org.miloss.fgsms.services.interfaces.common.NameValuePair> set, String name) returns a live copy of the select nvp if it exists, or null
static Connection	getPerformanceDB_NONPOOLED_Connection() Deprecated.
static Connection	getPerformanceDBConnection() returns a JDNI pooled database connection if the primary cannot be reached, the secondary is used or null is returned.
static JAXBContext	getSerializationContext() Gets a JAXBContext object which is used to create a serializer/deserializer.
static boolean	hasEmailSLA(org.miloss.fgsms.services.interfaces.policyconfiguration.ArrayOfSLAActionBaseType pc) does this action list contain an email SLA
static boolean	hasEmailSLA(org.miloss.fgsms.services.interfaces.policyconfiguration.ServicePolicy pc) does this policy have an email sla action?
static String	ICMClassificationToColorCodeString(us.gov.ic.ism.v2.ClassificationType type) ICISM to color codes
static String	ICMClassificationToString(us.gov.ic.ism.v2.ClassificationType type) pretty print for ICISM class levels
static String	listStringtoString(List<String> data) converts a list of string to a single string whitespace, null and empty strings are ignored
static org.miloss.fgsms.services.interfaces.policyconfiguration.SLAAction	newEmailAction(String from, String subject, String body) creates a new send an email sla action
static org.miloss.fgsms.services.interfaces.policyconfiguration.KeyNameValue	newKeyNameValue(String key, String name, String value) convenience wrapper
static org.miloss.fgsms.services.interfaces.policyconfiguration.KeyNameValueEnc	newKeyNameValueEnc(org.miloss.fgsms.services.interfaces.policyconfiguration.KeyNameValue value, boolean shouldEncrypt) convenience wrapper
static org.miloss.fgsms.services.interfaces.common.NameValuePair	newNameValuePair(String name, String val, boolean encrypted, boolean encryptOnSave) convenience method for NVP
static org.miloss.fgsms.services.interfaces.policyconfiguration.Plugin	newPlugin(String classname, String displayname, String appliesto) a convenience wrapper to create a new plugin instance
static Calendar	parseDateTime(String s) Parses the date/time stamp from a given input parameter using one of the following formats mm/dd/yyyy mm/dd/yyyy hh:mm:ss EEE MMM dd HH:mm:ss zzz yyyy - this is the standard output from the unix date command EEE mm/dd/yyyy HH:mm:ss.ms - this is the standard output from the windows command echo %date% %time% yyyy-MM-ddThh:mm:ss.zzzzzzz Epoch time (ms) PnYnMnDTnHnMnS - XML lexical representation
static boolean	stringIsNullOrEmpty(String s) string is null or empty
static String	truncate(String x, int length) String Truncator if a null or empty string is passed, an empty string is returned
static void	validateClassification(org.miloss.fgsms.services.interfaces.common.SecurityWrapper w) throws an illegal argument exception if the object is null or not specified, caveats is options

Methods inherited from class java.lang.Object

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

Field Detail

logname

public static final String logname

See Also:

Constant Field Values

JDBC_PERFORMANCE

public static final String JDBC_PERFORMANCE

See Also:

Constant Field Values

JDBC_CONFIG

public static final String JDBC_CONFIG

See Also:

Constant Field Values

SECONDARY_POSTIFX

public static final String SECONDARY_POSTIFX

See Also:

Constant Field Values

PropertyFilePath

public static final String PropertyFilePath

See Also:

Constant Field Values

Constructor Detail

Utility

public Utility()

Method Detail

formatDateTime

public static String formatDateTime(Calendar cal)

formatDateTime

public static String formatDateTime(Date cal)

formatDateTime

public static String formatDateTime(long timestampEpoch)

parseDateTime

public static Calendar parseDateTime(String s)
                              throws Exception

Parses the date/time stamp from a given input parameter using one of the following formats

• mm/dd/yyyy
• mm/dd/yyyy hh:mm:ss
• EEE MMM dd HH:mm:ss zzz yyyy - this is the standard output from the unix date command
• EEE mm/dd/yyyy HH:mm:ss.ms - this is the standard output from the windows command echo %date% %time%
• yyyy-MM-ddThh:mm:ss.zzzzzzz
• Epoch time (ms)
• PnYnMnDTnHnMnS - XML lexical representation

Parameters:

s - the input string

Returns:

a non-null instance of Calendar matching the interpreted date.

Throws:

Exception - if the date cannot be parsed

addStatusChangeSLA

public static void addStatusChangeSLA(org.miloss.fgsms.services.interfaces.policyconfiguration.ServicePolicy ret)

Addings the default Status Change SLA for email alerts

Parameters:

ret -

getARSSerializationContext

public static JAXBContext getARSSerializationContext()
                                              throws JAXBException

used by the Automated Reporting Service, creates a jaxb context to serialize/deserial a reporting job

Returns:

Throws:

JAXBException

getSerializationContext

public static JAXBContext getSerializationContext()
                                           throws JAXBException

Gets a JAXBContext object which is used to create a serializer/deserializer. Useage is only guaranteed for serializing ServicePolicy, AddData, AddMoreData objects

Returns:

Throws:

JAXBException

validateClassification

public static void validateClassification(org.miloss.fgsms.services.interfaces.common.SecurityWrapper w)

throws an illegal argument exception if the object is null or not specified, caveats is options

Parameters:

w -

getHostName

public static String getHostName()

returns the lowercase hostname

Returns:

hasEmailSLA

public static boolean hasEmailSLA(org.miloss.fgsms.services.interfaces.policyconfiguration.ServicePolicy pc)

does this policy have an email sla action?

Parameters:

pc -

Returns:

hasEmailSLA

public static boolean hasEmailSLA(org.miloss.fgsms.services.interfaces.policyconfiguration.ArrayOfSLAActionBaseType pc)

does this action list contain an email SLA

Parameters:

pc -

Returns:

EN

public static String EN(String clear)

encrypts a password AES 256 bit Requires the Unlimited Strength Crypto Extensions

Parameters:

clear -

Returns:

DE

public static String DE(String cipher)

Decrypts a password or other sensitive data. If the parameter is null or empty, an empty string is returned. If the parameter is not encrypted or was encrypted using a different key or it fails to decrypt, the original text is returned.

Parameters:

cipher -

Returns:

durationToString

public static String durationToString(Duration d)

Converts a duration to 1yr 1mo 1d 1hr 1min 1s string format

Parameters:

d -

Returns:

durationLargestUnitToString

public static String durationLargestUnitToString(Duration d)

returns just the largest unit of measure for durations up to years

Parameters:

d -

Returns:

ICMClassificationToString

public static String ICMClassificationToString(us.gov.ic.ism.v2.ClassificationType type)

pretty print for ICISM class levels

Parameters:

type -

Returns:

ICMClassificationToColorCodeString

public static String ICMClassificationToColorCodeString(us.gov.ic.ism.v2.ClassificationType type)

ICISM to color codes

Parameters:

type -

Returns:

listStringtoString

public static String listStringtoString(List<String> data)

converts a list of string to a single string whitespace, null and empty strings are ignored

getActionNameFromXML

public static String getActionNameFromXML(String xml)

uses a variety of classes to determine the name of the first XML child node of a SOAP:envelope node

Parameters:

xml -

Returns:

encodeHTML

public static String encodeHTML(String s)

HTML encodes strings to prevent CXS, if the parameter is an null or empty, an empty string is returned, but never null

Parameters:

s -

Returns:

stringIsNullOrEmpty

public static boolean stringIsNullOrEmpty(String s)

string is null or empty

Parameters:

s -

Returns:

durationToTimeInMS

public static long durationToTimeInMS(Duration d)

converts a duration to time in ms

Parameters:

d -

Returns:

truncate

public static String truncate(String x,
              int length)

String Truncator if a null or empty string is passed, an empty string is returned

Parameters:

x -

length -

Returns:

getPerformanceDB_NONPOOLED_Connection

@Deprecated
public static Connection getPerformanceDB_NONPOOLED_Connection()

Deprecated.

returns a NON pooled database connection by using the data in the database.properties if the primary cannot be reached, the secondary is used or null is returned. configuration is loaded from the database.properties embedded within fgsms.common.jar

Returns:

getConfigurationDB_NONPOOLED_Connection

@Deprecated
public static Connection getConfigurationDB_NONPOOLED_Connection()

Deprecated.

returns a NON pooled database connection by using the data in the database.properties if the primary cannot be reached, the secondary is used or null is returned. configuration is loaded from the database.properties embedded within fgsms.common.jar

Returns:

getPerformanceDBConnection

public static Connection getPerformanceDBConnection()

returns a JDNI pooled database connection if the primary cannot be reached, the secondary is used or null is returned. java:fgsmsPerformance java:fgsmsPerformanceSecondary be sure to close the connection when finished

Returns:

null if a connection cannot be established

getConfigurationDBConnection

public static Connection getConfigurationDBConnection()

returns a JDNI pooled database connection if the primary cannot be reached, the secondary is used or null is returned. java:fgsmsConfig java:fgsmsConfigSecondary

Returns:

newNameValuePair

public static org.miloss.fgsms.services.interfaces.common.NameValuePair newNameValuePair(String name,
                                                                         String val,
                                                                         boolean encrypted,
                                                                         boolean encryptOnSave)

convenience method for NVP

Parameters:

name -

val -

encrypted -

encryptOnSave -

Returns:

newEmailAction

public static org.miloss.fgsms.services.interfaces.policyconfiguration.SLAAction newEmailAction(String from,
                                                                                String subject,
                                                                                String body)

creates a new send an email sla action

Parameters:

from -

subject -

body -

Returns:

getNameValuePairByName

public static org.miloss.fgsms.services.interfaces.common.NameValuePair getNameValuePairByName(List<org.miloss.fgsms.services.interfaces.common.NameValuePair> set,
                                                                               String name)

returns a live copy of the select nvp if it exists, or null

Parameters:

set -

name -

Returns:

newPlugin

public static org.miloss.fgsms.services.interfaces.policyconfiguration.Plugin newPlugin(String classname,
                                                                        String displayname,
                                                                        String appliesto)

a convenience wrapper to create a new plugin instance

Parameters:

classname -

displayname -

appliesto - FEDERATION_PUBLISH,SLA_RULE,SLA_ACTION, LOGGER

Returns:

getAllPolicyTypes

public static List<org.miloss.fgsms.services.interfaces.common.PolicyType> getAllPolicyTypes()

containsPolicyType

public static boolean containsPolicyType(List<org.miloss.fgsms.services.interfaces.common.PolicyType> appliesTo,
                         org.miloss.fgsms.services.interfaces.common.PolicyType optionalPolicyTypeFilter)

convenience method, does the list contain the policy type

Parameters:

appliesTo -

optionalPolicyTypeFilter -

Returns:

newKeyNameValue

public static org.miloss.fgsms.services.interfaces.policyconfiguration.KeyNameValue newKeyNameValue(String key,
                                                                                    String name,
                                                                                    String value)

convenience wrapper

Parameters:

key -

name -

value -

Returns:

newKeyNameValueEnc

public static org.miloss.fgsms.services.interfaces.policyconfiguration.KeyNameValueEnc newKeyNameValueEnc(org.miloss.fgsms.services.interfaces.policyconfiguration.KeyNameValue value,
                                                                                          boolean shouldEncrypt)

convenience wrapper

Parameters:

value -

shouldEncrypt -

Returns: