oracle.apps.fnd.appltest.diagfwk.engine.impl
Class DiagJAXBXMLDoc<T>

java.lang.Object
  oracle.apps.fnd.appltest.diagfwk.engine.impl.DiagBObjImpl<T>
      oracle.apps.fnd.appltest.diagfwk.engine.impl.DiagJAXBXMLDoc<T>

All Implemented Interfaces:

DiagConstants, DiagBObj<T>

Direct Known Subclasses:

DiagJAXBXMLDocReport, TestDefImpl

public abstract class DiagJAXBXMLDoc<T>
extends DiagBObjImpl<T>

Represents a diagnostics business object that can be represented in XML and marshalled and unmarshalled using JAXB

Since:

release specific (what release of product did this appear in)

Version:

$Header: atgpf/appltest/applications/Diagnostics/Engine/src/oracle/apps/fnd/appltest/diagfwk/engine/impl/DiagJAXBXMLDoc.java /main/10 2009/08/17 10:56:16 anautiya Exp $

Author:

ppradhan

Nested Class Summary

Nested classes/interfaces inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

DiagConstants.ExecutionMode, DiagConstants.Format, DiagConstants.LinkType, DiagConstants.Status

Field Summary

protected oracle.apps.fnd.appllcm.sdk.common.ResourceRef	errMsgOnLoadXML
protected oracle.apps.fnd.appllcm.sdk.common.ResourceRef	errMsgOnValXML

Fields inherited from interface oracle.apps.fnd.appltest.diagfwk.common.DiagConstants

APPS_MSG_ID_TAG_NAME, CFG_ADR_PROVIDER_CLASS, CFG_CACHE_PROVIDER_CLASS, CFG_CRED_PROVIDER_CLASS, CFG_DAO_FACTORY_CLASS, CFG_DB_CONN_INFO_PROVIDER_CLASS, CFG_DB_CONN_PROVIDER_CLASS, CFG_NLS_PROVIDER_CLASS, CFG_PLSQL_PROVIDER_CLASS, CFG_PROFILE_PROVIDER_CLASS, CFG_SECURITY_PROVIDER_CLASS, CFG_SESSION_INFO_PROVIDER_CLASS, CFG_URL_PROVIDER_FACTORY_CLASS, CFG_WLS_MBEANSRV_CONNINFO_PROVIDER_CLASS, DATA_SECURITY_PERMISSION_ALLOWED, DATA_SECURITY_PERMISSION_NOT_ALLOWED, DELIM_URL, EXEC_MODE_CLI, EXEC_MODE_ESS, EXEC_MODE_INCIDENT, EXEC_MODE_JAVA, EXEC_MODE_UI, EXECUTABLE_TYPE_JAVA, EXECUTABLE_TYPE_PLSQL, EXECUTABLE_TYPE_TESTREF, FORMAT_HTML, FORMAT_XML, GUID_ORACLE_MINUS1, GUID_ORACLE_ZERO, INPUTS_STATUS_ALL_OPT_INPUTS, INPUTS_STATUS_NO_INPUTS, INPUTS_STATUS_REQ_INPUTS_NO_DEFAULTS, INPUTS_STATUS_REQ_INPUTS_W_DEFAULTS, IO_FLAG_I, IO_FLAG_O, JMX_API_BASE_OBJECT_NAME, LINK_EXTERNAL, LINK_INTERNAL, LINK_METALINK, N, NLS_BUNDLE_JAVA_RES, NLS_BUNDLE_MSG_SVC, NLS_BUNDLE_RES_REF, NLS_BUNDLE_XLIFF, NO, NULL, ODF_MBEAN_DOMAIN_NAME, PARAM_MON_INTERVAL, PLSQL_DEBUG_ENABLED_SYSTEM_PROP, PREREQ_TYPE_TAG_VALUE, PREREQ_TYPE_TEST, SECONDS_IN_ONE_DAY, SECONDS_IN_ONE_HOUR, STATUS_CANCELED, STATUS_EXECERROR, STATUS_FAILURE, STATUS_RUNNING, STATUS_SUCCESS, STATUS_WARNING, SYS_PROP_MAX_MONITOR_INTERNVAL, SYS_PROP_MAX_NUM_THREADS, SYSPROP_APPCONNFILE, SYSPROP_DIAG_CONFIG_FILE, TAG_TYPE_DIAG, TAG_TYPE_TAXONOMY, TEST_TYPE_DECL, TEST_TYPE_JAVA, USER_NAME, WEB_APP_NAME_TAG_NAME, Y, YES

Constructor Summary

DiagJAXBXMLDoc()

Method Summary

protected oracle.apps.fnd.appllcm.sdk.common.ResourceRef	getErrMsgOnLoadXML() Gets the ResourceRef modeling the error message for any errors that occur when loading the XML document
protected oracle.apps.fnd.appllcm.sdk.common.ResourceRef	getErrMsgOnValXML() Returns the ResourceRef representing the validation error message
protected abstract oracle.apps.fnd.appllcm.sdk.common.ResourceRef	getErrorMsgOnLoadXmlErr() Returns an instance of the resource with the error message when there is an failure to load XML using JAXB
protected abstract oracle.apps.fnd.appllcm.sdk.common.ResourceRef	getErrorMsgOnXmlValErr(int pLine, int pCol, java.lang.String pMsg) Returns an instance of the resource with the error message when there is validation error in the source XML
protected abstract java.lang.Object	getJAXBMetadataObj() Gets the top level JAXB object for the metadata
protected abstract java.lang.String	getJAXBPkg() Gets the JAXB object package for this metadata
protected void	load(org.xml.sax.InputSource s) Populates this object from the given test definition metadata input source.
protected abstract void	performPostLoad() Callback hook for performing any post-load operations after loading of a XML document.
protected void	reactToValidationEvents(javax.xml.bind.util.ValidationEventCollector pVC, oracle.apps.fnd.appllcm.sdk.common.LCMLog pLog, java.lang.Exception e) Reacts to the given set of validation events in the given VaildationCollector by i) logging the events at an appropriate level ii) throwing an LCMException in case of any fatal errors or errors.
protected void	saveJAXB() Saves the JAXB Object tree into a String format and sets it on this object by calling setJAXBMetadataStr() API
protected void	saveToFile(java.lang.String pOutfile) Saves the JAXB content tree to the file system at the given file path location.
protected void	setErrMsgOnLoadXML(oracle.apps.fnd.appllcm.sdk.common.ResourceRef newerrMsgOnLoadXML) Sets the ResourceRef modeling the error message for any errors that occur when loading the XML document
protected void	setErrMsgOnValXML(oracle.apps.fnd.appllcm.sdk.common.ResourceRef newerrMsgOnValXML) Sets the ResourceRef representing the validation error message
protected abstract void	setJAXBMetadataObj(java.lang.Object pMd) Sets the top level JAXB object for the metadata
protected abstract void	setJAXBMetadataStr(java.lang.String pXMLStr) Sets the marshalled XML document for the metadata in String format

Methods inherited from class oracle.apps.fnd.appltest.diagfwk.engine.impl.DiagBObjImpl

copy, copyCommon, getCreatedBy, getCreationDate, getLastUpdateDate, getLastUpdatedBy, getLastUpdateLogin, isCreatedByOracle, setCreatedBy, setCreationDate, setLastUpdateDate, setLastUpdatedBy, setLastUpdateLogin

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.apps.fnd.appltest.diagfwk.engine.DiagBObj

copyT

Field Detail

errMsgOnLoadXML

protected oracle.apps.fnd.appllcm.sdk.common.ResourceRef errMsgOnLoadXML

errMsgOnValXML

protected oracle.apps.fnd.appllcm.sdk.common.ResourceRef errMsgOnValXML

Constructor Detail

DiagJAXBXMLDoc

public DiagJAXBXMLDoc()

Method Detail

setJAXBMetadataObj

protected abstract void setJAXBMetadataObj(java.lang.Object pMd)

Sets the top level JAXB object for the metadata

Parameters:

pMd - the top level JAXB object for the metadata

getJAXBMetadataObj

protected abstract java.lang.Object getJAXBMetadataObj()

Gets the top level JAXB object for the metadata

Returns:

the top level JAXB object for the metadata

setJAXBMetadataStr

protected abstract void setJAXBMetadataStr(java.lang.String pXMLStr)

Sets the marshalled XML document for the metadata in String format

Parameters:

pXMLStr - marshalled XML document

getJAXBPkg

protected abstract java.lang.String getJAXBPkg()

Gets the JAXB object package for this metadata

Returns:

the JAXB package name for this metadata

getErrorMsgOnLoadXmlErr

protected abstract oracle.apps.fnd.appllcm.sdk.common.ResourceRef getErrorMsgOnLoadXmlErr()

Returns an instance of the resource with the error message when there is an failure to load XML using JAXB

Returns:

an instance of the resource with the error message when there is an failure to load XML using JAXB

getErrorMsgOnXmlValErr

protected abstract oracle.apps.fnd.appllcm.sdk.common.ResourceRef getErrorMsgOnXmlValErr(int pLine,
                                                                                         int pCol,
                                                                                         java.lang.String pMsg)

Returns an instance of the resource with the error message when there is validation error in the source XML

Parameters:

pLine - line number where the error occurred

pCol - column number where the error occurred

pMsg - validation error message

Returns:

an instance of the resource with the error message when there is validation error in the source XML

performPostLoad

protected abstract void performPostLoad()

Callback hook for performing any post-load operations after loading of a XML document. Such operations may include, but are not limited to, performing further validations on the document.

load

protected void load(org.xml.sax.InputSource s)

Populates this object from the given test definition metadata input source.

Parameters:

s - input source for test definition metadata

saveJAXB

protected void saveJAXB()

Saves the JAXB Object tree into a String format and sets it on this object by calling setJAXBMetadataStr() API

saveToFile

protected void saveToFile(java.lang.String pOutfile)

Saves the JAXB content tree to the file system at the given file path location.

Parameters:

pOutfile - file path location for the output XML file.

reactToValidationEvents

protected void reactToValidationEvents(javax.xml.bind.util.ValidationEventCollector pVC,
                                       oracle.apps.fnd.appllcm.sdk.common.LCMLog pLog,
                                       java.lang.Exception e)

Reacts to the given set of validation events in the given VaildationCollector by i) logging the events at an appropriate level ii) throwing an LCMException in case of any fatal errors or errors.

Parameters:

pLog - - Logger to log to

pVC - - collection of validation events

e - - any base exception that was encountered.

Throws:

oracle.apps.fnd.appllcm.sdk.common.LCMException - in case of any validation errors

setErrMsgOnLoadXML

protected void setErrMsgOnLoadXML(oracle.apps.fnd.appllcm.sdk.common.ResourceRef newerrMsgOnLoadXML)

Sets the ResourceRef modeling the error message for any errors that occur when loading the XML document

Parameters:

newerrMsgOnLoadXML -

getErrMsgOnLoadXML

protected oracle.apps.fnd.appllcm.sdk.common.ResourceRef getErrMsgOnLoadXML()

Gets the ResourceRef modeling the error message for any errors that occur when loading the XML document

Returns:

setErrMsgOnValXML

protected void setErrMsgOnValXML(oracle.apps.fnd.appllcm.sdk.common.ResourceRef newerrMsgOnValXML)

Sets the ResourceRef representing the validation error message

Parameters:

newerrMsgOnValXML -

getErrMsgOnValXML

protected oracle.apps.fnd.appllcm.sdk.common.ResourceRef getErrMsgOnValXML()

Returns the ResourceRef representing the validation error message

Returns:

the ResourceRef representing the validation error message