com.accela.aa.emse.dom

Class UtilScript

java.lang.Object

com.accela.aa.emse.dom.service.BaseAAScript

com.accela.aa.emse.dom.UtilScript

All Implemented Interfaces:

com.accela.aa.emse.dom.service.ScriptAble, com.accela.aa.emse.dom.service.UtilScriptService, java.io.Serializable

public class UtilScript
extends com.accela.aa.emse.dom.service.BaseAAScript
implements java.io.Serializable, com.accela.aa.emse.dom.service.UtilScriptService

 
  Accela Automation
  File: UtilScript.java
 
  Accela, Inc.
  Copyright (C): 2001-2014
 
  Description: EMSE script util class.
 
  Notes:
        $Id: UtilScript.java 270462 2014-04-28 10:05:58Z ..\rain.wang $
 
  Revision History:
  Feb 24, 2004, Joey Lv Initial Version.
  Oct 30, 2004, Sunny Wu        Added method toObjectArray(Object obj).
  12/22/04        Edwin Lin  solve HTTP Authentication problem.
  07/19/2005    Edwin Lin  Add the newArrayList()
  03/21/2006    Yan Xiao         Added two new methodd named writeToFile/ftpUpload for the requirement 06ACT-00580 - AA-CFW & RC Interface.
 

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
UtilScript() UtilScript Constructor.
UtilScript(java.lang.String serviceProviderCode, java.lang.String auditID, com.accela.aa.emse.dom.service.CachedService cachedService) UtilScript Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
double	add(double firstValue, double secondValue) Returns a double whose value is (firstValue + secondValue).
ScriptResult	batchUpdate(java.lang.String dataSourceName, java.lang.String sqlString, java.util.List<java.lang.Object[]> parameters) Batch Insert, delete or update custom DB directly in EMSE script To use this API, you need to follow below steps: 1.
int	compare(double firstValue, double secondValue) Compares the firstValue with the secondeValue.
java.util.Date	dateDiff(java.util.Date date, java.lang.String intervalType, int interval) Date diff.
ScriptResult	deepClone(java.lang.Object srcObject) Do deep object clone.
void	deleteFile(java.lang.String fileName) Delete a special file.
double	divide(double dividend, double divisor) Returns a double whose value is (dividend / divisor).
double	divide(double dividend, double divisor, int scale) Returns a double whose value is (dividend / divisor).
java.lang.Double	doubleFormat(java.lang.Double amount) Format double to keep two decimal digits .
java.lang.String	formatDate(java.util.Date date, java.lang.String format) Format date.
java.lang.String	formatFee(double fee) Format double to keep two decimal digits.
static ScriptResult	ftpUpload(java.lang.String site, java.lang.String port, java.lang.String username, java.lang.String password, java.lang.String folder, java.io.File file) Method to upload one file to a ftp site.
java.util.Calendar	getCalendar() Gets the calendar.
java.lang.String	getCustomContentByType(java.lang.String contentType, java.util.Hashtable parameters) replace parameter for Email.
java.lang.String	getCustomContentByType4InspScheAfter(java.lang.String contentType, com.accela.aa.inspection.inspection.InspectionModel inspection, com.accela.aa.aamain.cap.CapIDModel capIdModel, java.util.Hashtable<java.lang.String,java.lang.String> parameters) Replace parameter for the event InspectionScheduleAfter.
java.lang.String	getCustomDescAsSubjectByType(java.lang.String contentType, java.util.Hashtable parameters) Get custom desc As subject by contentType.
ScriptResult	getDeadlineDay(java.util.Date currectDate, java.util.Date registrationDate, java.lang.String deadline) get deadline's day.
com.accela.util.AVLogger	getLogger() Utility to return Utility logger in order to allow scripts to log information into server.log on the application server
java.lang.String	getValueFromXML(java.lang.String tag, java.lang.String registerResultXML) match value by teg from string.
ScriptResult	httpPost(java.lang.String url, java.lang.String parameters) httpPost method.
ScriptResult	httpPost(java.lang.String url, java.lang.String userName, java.lang.String passWord) httpPost for HTTP Authentication.
ScriptResult	httpPost(java.lang.String url, java.lang.String parameters, java.lang.String userName, java.lang.String passWord) httpPost for HTTP Authentication.
ScriptResult	httpPostToSoapWebService(java.lang.String url, java.lang.String parameters, java.lang.String userName, java.lang.String passWord, java.lang.String sSoapAction) httpPostToSoapWebService for HTTP Authentication.
boolean	instanceOfString(java.lang.Object obj) Check to see if the object is data model.
static void	main(java.lang.String[] ares) Main method.
double	multiply(double firstValue, double secondValue) Returns a double whose value is (firstValue * secondValue).
java.util.ArrayList	newArrayList() Utility to construct a new java.util.ArrayList
java.util.HashMap	newHashMap() Utility to construct a new java.util.HashMap
java.util.Hashtable	newHashtable() create an instance for Hashtable.
com.accela.aa.util.QueryFormat	newQueryFormat() Utility to construct a new QueryFormat.
java.lang.StringBuffer	newStringBuffer() Utility to construct a new java.lang.StringBuffer
java.util.Date	now() Now.
java.lang.String	numberFormat(java.lang.Double number) format number.
java.util.Date	parseDate(java.lang.String dateString) Takes a string formatted as a date.
java.lang.Double	parseDouble(java.lang.String value) Parses the double.
java.lang.Integer	parseInt(java.lang.String value) Parses the int.
java.lang.Long	parseLong(java.lang.String value) Parses the long.
double	round(double d, int scale) Returns a double whose value is round to scale.
ScriptResult	select(java.lang.String dataSourceName, java.lang.String sqlString, java.lang.Object[] parameters) Select in custom DB directly in EMSE script To use this API, you need to follow below steps: 1.
double	subtract(double minuend, double subtrahend) Returns a double whose value is (minuend - subtrahend).
ScriptResult	toObjectArray(java.lang.Object obj) Convert to ObjectArray.
ScriptResult	update(java.lang.String dataSourceName, java.lang.String sqlString, java.lang.Object[] parameters) Insert, delete or update custom DB directly in EMSE script To use this API, you need to follow below steps: 1.
java.io.File	writeToFile(java.lang.Object obj, java.lang.String fileName) Method to write to file.

Methods inherited from class com.accela.aa.emse.dom.service.BaseAAScript

initScript

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.accela.aa.emse.dom.service.ScriptAble

initScript

Constructor Detail

UtilScript

public UtilScript(java.lang.String serviceProviderCode,
          java.lang.String auditID,
          com.accela.aa.emse.dom.service.CachedService cachedService)
           throws com.accela.aa.exception.AAException

UtilScript Constructor.

Parameters:

serviceProviderCode - agency code

auditID - the caller id

Throws:

com.accela.aa.exception.AAException - The AA exception

UtilScript

public UtilScript()
           throws com.accela.aa.exception.AAException

UtilScript Constructor.

Throws:

com.accela.aa.exception.AAException - The AA exception

Method Detail

httpPost

public ScriptResult httpPost(java.lang.String url,
                    java.lang.String parameters)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

httpPost method.

Specified by:

httpPost in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

url - url address

parameters - parameters

Returns:

ScriptResult

httpPost

public ScriptResult httpPost(java.lang.String url,
                    java.lang.String userName,
                    java.lang.String passWord)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

httpPost for HTTP Authentication.

Specified by:

httpPost in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

url - url address

userName - the user name

passWord - the password

Returns:

ScriptResult

httpPost

public ScriptResult httpPost(java.lang.String url,
                    java.lang.String parameters,
                    java.lang.String userName,
                    java.lang.String passWord)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

httpPost for HTTP Authentication.

Specified by:

httpPost in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

url - url address

parameters - parameters

userName - the user name

passWord - the password

Returns:

ScriptResult

httpPostToSoapWebService

public ScriptResult httpPostToSoapWebService(java.lang.String url,
                                    java.lang.String parameters,
                                    java.lang.String userName,
                                    java.lang.String passWord,
                                    java.lang.String sSoapAction)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

httpPostToSoapWebService for HTTP Authentication.

Specified by:

httpPostToSoapWebService in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

url - the url

parameters - the parameters

userName - the user name

passWord - the pass word

sSoapAction - the s soap action

Returns:

ScriptResult

toObjectArray

public ScriptResult toObjectArray(java.lang.Object obj)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Convert to ObjectArray.

Specified by:

toObjectArray in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

obj - Object

Returns:

ScriptResult

newHashMap

public java.util.HashMap newHashMap()

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Utility to construct a new java.util.HashMap

Specified by:

newHashMap in interface com.accela.aa.emse.dom.service.UtilScriptService

Returns:

new java.util.HashMap Assume success because only real possible error is OutOfMemory.

newHashtable

public java.util.Hashtable newHashtable()

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

create an instance for Hashtable.

Specified by:

newHashtable in interface com.accela.aa.emse.dom.service.UtilScriptService

Returns:

the hashtable

getCustomContentByType

public java.lang.String getCustomContentByType(java.lang.String contentType,
                                      java.util.Hashtable parameters)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

replace parameter for Email.

Specified by:

getCustomContentByType in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

contentType - the content type

parameters - the parameters

Returns:

the custom content by type

getCustomDescAsSubjectByType

public java.lang.String getCustomDescAsSubjectByType(java.lang.String contentType,
                                            java.util.Hashtable parameters)

Get custom desc As subject by contentType.

Parameters:

contentType -

parameters -

Returns:

getCustomContentByType4InspScheAfter

public java.lang.String getCustomContentByType4InspScheAfter(java.lang.String contentType,
                                                    com.accela.aa.inspection.inspection.InspectionModel inspection,
                                                    com.accela.aa.aamain.cap.CapIDModel capIdModel,
                                                    java.util.Hashtable<java.lang.String,java.lang.String> parameters)

Replace parameter for the event InspectionScheduleAfter.

Parameters:

contentType - Content Type.

inspection - Inspection Model.

capIdModel - CapIDModel.

parameters - variables.

Returns:

String.

newArrayList

public java.util.ArrayList newArrayList()

Utility to construct a new java.util.ArrayList

Specified by:

newArrayList in interface com.accela.aa.emse.dom.service.UtilScriptService

Returns:

new java.util.ArrayList

newStringBuffer

public java.lang.StringBuffer newStringBuffer()

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Utility to construct a new java.lang.StringBuffer

Specified by:

newStringBuffer in interface com.accela.aa.emse.dom.service.UtilScriptService

Returns:

new java.lang.StringBuffer Assume success because only real possible error is OutOfMemory.

newQueryFormat

public com.accela.aa.util.QueryFormat newQueryFormat()

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Utility to construct a new QueryFormat.

Specified by:

newQueryFormat in interface com.accela.aa.emse.dom.service.UtilScriptService

Returns:

new QueryFormat

getCalendar

public java.util.Calendar getCalendar()

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Gets the calendar.

Specified by:

getCalendar in interface com.accela.aa.emse.dom.service.UtilScriptService

Returns:

the calendar

formatDate

public java.lang.String formatDate(java.util.Date date,
                          java.lang.String format)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Format date.

Specified by:

formatDate in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

date - the date

format - the format

Returns:

the string

now

public java.util.Date now()

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Now.

Specified by:

now in interface com.accela.aa.emse.dom.service.UtilScriptService

Returns:

the date

parseDate

public java.util.Date parseDate(java.lang.String dateString)
                         throws com.accela.aa.exception.AAException

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Takes a string formatted as a date. The date string should be in one of the following formats: yyyy-MM-dd'T'hh:mm:ss, yyyy-MM-dd or MM/dd/yyyy

Specified by:

parseDate in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

dateString - the date string

Returns:

the date

Throws:

com.accela.aa.exception.AAException - the AA exception

dateDiff

public java.util.Date dateDiff(java.util.Date date,
                      java.lang.String intervalType,
                      int interval)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Date diff.

Specified by:

dateDiff in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

date - the date

intervalType - the interval type

interval - the interval

Returns:

the date

getLogger

public com.accela.util.AVLogger getLogger()

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Utility to return Utility logger in order to allow scripts to log information into server.log on the application server

Specified by:

getLogger in interface com.accela.aa.emse.dom.service.UtilScriptService

Returns:

com.accela.util.AVLogger

writeToFile

public java.io.File writeToFile(java.lang.Object obj,
                       java.lang.String fileName)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Method to write to file.

Specified by:

writeToFile in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

obj - the obj

fileName - the file name

Returns:

the File object

deleteFile

public void deleteFile(java.lang.String fileName)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Delete a special file.

Specified by:

deleteFile in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

fileName - the file name

ftpUpload

public static ScriptResult ftpUpload(java.lang.String site,
                     java.lang.String port,
                     java.lang.String username,
                     java.lang.String password,
                     java.lang.String folder,
                     java.io.File file)

Method to upload one file to a ftp site.

Parameters:

site - the site

port - the port

username - the username

password - the password

folder - the folder

file - the file

Returns:

the upload result

instanceOfString

public boolean instanceOfString(java.lang.Object obj)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Check to see if the object is data model. For EMSE parameter, the event parameter is string type by default.

Specified by:

instanceOfString in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

obj - the obj

Returns:

true, if instance of string

getValueFromXML

public java.lang.String getValueFromXML(java.lang.String tag,
                               java.lang.String registerResultXML)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

match value by teg from string.

Specified by:

getValueFromXML in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

tag - the tag

registerResultXML - the register result xml

Returns:

the value from xml

numberFormat

public java.lang.String numberFormat(java.lang.Double number)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

format number.

Specified by:

numberFormat in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

number - the number

Returns:

the string

parseInt

public java.lang.Integer parseInt(java.lang.String value)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Parses the int.

Specified by:

parseInt in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

value - the value

Returns:

the integer

parseLong

public java.lang.Long parseLong(java.lang.String value)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Parses the long.

Specified by:

parseLong in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

value - the value

Returns:

the long

parseDouble

public java.lang.Double parseDouble(java.lang.String value)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Parses the double.

Specified by:

parseDouble in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

value - the value

Returns:

the double

getDeadlineDay

public ScriptResult getDeadlineDay(java.util.Date currectDate,
                          java.util.Date registrationDate,
                          java.lang.String deadline)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

get deadline's day.

Specified by:

getDeadlineDay in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

currectDate - the currect date

registrationDate - the registration date

deadline - the deadline

Returns:

the deadline day

subtract

public double subtract(double minuend,
              double subtrahend)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Returns a double whose value is (minuend - subtrahend).

Specified by:

subtract in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

minuend - minuend value

subtrahend - subtrahend value

Returns:

minuend - subtrahend

add

public double add(double firstValue,
         double secondValue)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Returns a double whose value is (firstValue + secondValue).

Specified by:

add in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

firstValue - value to add

secondValue - value to add

Returns:

firstValue + secondValue

multiply

public double multiply(double firstValue,
              double secondValue)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Returns a double whose value is (firstValue * secondValue).

Specified by:

multiply in interface com.accela.aa.emse.dom.service.UtilScriptService

Returns:

divide

public double divide(double dividend,
            double divisor,
            int scale)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Returns a double whose value is (dividend / divisor).

Specified by:

divide in interface com.accela.aa.emse.dom.service.UtilScriptService

Returns:

divide

public double divide(double dividend,
            double divisor)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Returns a double whose value is (dividend / divisor).

Specified by:

divide in interface com.accela.aa.emse.dom.service.UtilScriptService

Returns:

round

public double round(double d,
           int scale)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Returns a double whose value is round to scale.

Specified by:

round in interface com.accela.aa.emse.dom.service.UtilScriptService

Returns:

compare

public int compare(double firstValue,
          double secondValue)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Compares the firstValue with the secondeValue.

Specified by:

compare in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

firstValue - the first value

secondValue - the second value

Returns:

-1, 0, or 1 as the firstValue is numerically less than, equal to, or greater than secondValue.

formatFee

public java.lang.String formatFee(double fee)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Format double to keep two decimal digits.

Specified by:

formatFee in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

fee - double to format.

Returns:

result.

doubleFormat

public java.lang.Double doubleFormat(java.lang.Double amount)

Description copied from interface: com.accela.aa.emse.dom.service.UtilScriptService

Format double to keep two decimal digits .

Specified by:

doubleFormat in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

amount - double to format

Returns:

the double

deepClone

public ScriptResult deepClone(java.lang.Object srcObject)

Do deep object clone. Please make sure that the object/sub objects is serializable.

Specified by:

deepClone in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

srcObject - object will be cloned.

Returns:

update

public ScriptResult update(java.lang.String dataSourceName,
                  java.lang.String sqlString,
                  java.lang.Object[] parameters)

Insert, delete or update custom DB directly in EMSE script To use this API, you need to follow below steps: 1. For oracle, find file {$HOME$}\av.biz\deploy\oracle-ds.xml, for MSSQL, find file {$HOME$}\av.biz\deploy\AVVembuMSSQL-ds.xml 2. Enable which was commented, it's the data source configuration. 3. Find file {$HOME$}\av.biz\conf\av\ServerConfig.properties and enable jdbc.custom.datasource

Specified by:

update in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

dataSourceName - Data Source Name

sqlString - sql which hoped to execute

parameters - parameters needed in sql

Returns:

update impact count

batchUpdate

public ScriptResult batchUpdate(java.lang.String dataSourceName,
                       java.lang.String sqlString,
                       java.util.List<java.lang.Object[]> parameters)

Batch Insert, delete or update custom DB directly in EMSE script To use this API, you need to follow below steps: 1. For oracle, find file {$HOME$}\av.biz\deploy\oracle-ds.xml, for MSSQL, find file {$HOME$}\av.biz\deploy\AVVembuMSSQL-ds.xml 2. Enable which was commented, it's the data source configuration. 3. Find file {$HOME$}\av.biz\conf\av\ServerConfig.properties and enable jdbc.custom.datasource

Specified by:

batchUpdate in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

dataSourceName - Data Source Name

sqlString - sql which hoped to execute

parameters - List of parameters needed in sql

Returns:

update impact count

select

public ScriptResult select(java.lang.String dataSourceName,
                  java.lang.String sqlString,
                  java.lang.Object[] parameters)

Select in custom DB directly in EMSE script To use this API, you need to follow below steps: 1. For oracle, find file {$HOME$}\av.biz\deploy\oracle-ds.xml, for MSSQL, find file {$HOME$}\av.biz\deploy\AVVembuMSSQL-ds.xml 2. Enable which was commented, it's the data source configuration. 3. Find file {$HOME$}\av.biz\conf\av\ServerConfig.properties and enable jdbc.custom.datasource

Specified by:

select in interface com.accela.aa.emse.dom.service.UtilScriptService

Parameters:

dataSourceName - Data Source Name

sqlString - sql which hoped to execute

parameters - parameters needed in sql

Returns:

List of select result

main

public static void main(java.lang.String[] ares)

Main method.

Parameters:

ares - the ares

Throws:

java.lang.Exception