Package org.serviceconnector.web.xml

Class AbstractXMLLoader

java.lang.Object

org.serviceconnector.web.xml.AbstractXMLLoader

All Implemented Interfaces:

IXMLLoader

Direct Known Subclasses:

AjaxContentXMLLoader, AjaxMaintenanceXMLLoader, AjaxResourceXMLLoader, AjaxSystemXMLLoader, CacheXMLLoader, DefaultXMLLoader, DumpXMLLoader, LogsXMLLoader, MaintenanceXMLLoader, ResourceXMLLoader, RespondersXMLLoader, ServersXMLLoader, ServicesXMLLoader, SessionsXMLLoader, SubscriptionsXMLLoader, TimerXMLLoader

public abstract class AbstractXMLLoader
extends Object
implements IXMLLoader

The Class AbstractXMLLoader.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractXMLLoader.Paging	The Class Paging for internal use only, holds paging data.

Field Summary

Fields

Modifier and Type	Field	Description
static final SimpleDateFormat	XMLSDF	The Constant XMLSDF.

Constructor Summary

Constructors

Constructor	Description
AbstractXMLLoader()	Instantiates a new abstract xml loader.

Method Summary

Modifier and Type	Method	Description
void	addMeta(String name, String value)	Adds the meta.
void	addMeta(Map<String,String> map)	Adds the meta.
protected SCClient	connectClientToService(Service service)	Connect client to service.
protected int	getParameterInt(IWebRequest request, String name, int defaultValue)	Gets the parameter int.
boolean	isText()	Checks if is text.
final void	load(IWebRequest request, OutputStream os)	Load.
void	loadBody(Writer writer, IWebRequest request)	Load body.
abstract void	loadBody(XMLStreamWriter writer, IWebRequest request)	Load body.
void	writeBean(XMLStreamWriter writer, Object obj)	Write bean.
void	writeFailure(XMLStreamWriter writer, String msg)	Write failure to xml stream using given message text.
void	writeHeaderMap(XMLStreamWriter writer, Map<String,String> map)	Write header map.
protected AbstractXMLLoader.Paging	writePagingAttributes(XMLStreamWriter writer, IWebRequest request, int size, String prefix)	Write paging attributes.
void	writeRuntime(XMLStreamWriter writer)	Write runtime.
void	writeSuccess(XMLStreamWriter writer, String msg)	Write success to xml stream using given message text.
void	writeSystem(XMLStreamWriter writer)	Write system.
void	writeWebInfo(XMLStreamWriter writer)	Write web info.
protected Date	writeXMLDate(XMLStreamWriter writer, IWebRequest request)

Methods inherited from class java.lang.Object

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

Field Details

XMLSDF

public static final SimpleDateFormat XMLSDF

The Constant XMLSDF.

Constructor Details

AbstractXMLLoader

public AbstractXMLLoader()

Instantiates a new abstract xml loader.

Method Details

isText

public boolean isText()

Checks if is text.

Specified by:

isText in interface IXMLLoader

Returns:

true, if is text true, if is raw

addMeta

public void addMeta(String name,
 String value)

Adds the meta.

Specified by:

addMeta in interface IXMLLoader

Parameters:

name - the name

value - the value the value

addMeta

public void addMeta(Map<String,String> map)

Adds the meta.

Specified by:

addMeta in interface IXMLLoader

Parameters:

map - the map the map

loadBody

public abstract void loadBody(XMLStreamWriter writer,
 IWebRequest request)
                       throws Exception

Load body.

Specified by:

loadBody in interface IXMLLoader

Parameters:

writer - the writer

request - the request

Throws:

Exception - the exception

loadBody

public void loadBody(Writer writer,
 IWebRequest request)
              throws Exception

Load body.

Specified by:

loadBody in interface IXMLLoader

Parameters:

writer - the writer

request - the request

Throws:

Exception - the exception

load

public final void load(IWebRequest request,
 OutputStream os)
                throws Exception

Load.

Specified by:

load in interface IXMLLoader

Parameters:

request - the request

os - the os

Throws:

Exception - the exception the exception

writeSystem

public void writeSystem(XMLStreamWriter writer)
                 throws XMLStreamException

Write system.

Parameters:

writer - the writer

Throws:

XMLStreamException - the xML stream exception

writeBean

public void writeBean(XMLStreamWriter writer,
 Object obj)
               throws XMLStreamException

Write bean.

Parameters:

writer - the writer

obj - the obj

Throws:

XMLStreamException - the xML stream exception

writeHeaderMap

public void writeHeaderMap(XMLStreamWriter writer,
 Map<String,String> map)
                    throws XMLStreamException

Write header map.

Parameters:

writer - the writer

map - the map

Throws:

XMLStreamException - the XML stream exception

writeWebInfo

public void writeWebInfo(XMLStreamWriter writer)
                  throws XMLStreamException

Write web info.

Parameters:

writer - the writer

Throws:

XMLStreamException - the xML stream exception

writeRuntime

public void writeRuntime(XMLStreamWriter writer)
                  throws XMLStreamException

Write runtime.

Parameters:

writer - the writer

Throws:

XMLStreamException - the xML stream exception

writeSuccess

public void writeSuccess(XMLStreamWriter writer,
 String msg)
                  throws Exception

Write success to xml stream using given message text.

Parameters:

writer - the writer

msg - the msg

Throws:

Exception - the exception

writeFailure

public void writeFailure(XMLStreamWriter writer,
 String msg)
                  throws Exception

Write failure to xml stream using given message text.

Parameters:

writer - the writer

msg - the msg

Throws:

Exception - the exception

connectClientToService

protected SCClient connectClientToService(Service service)
                                   throws WebCommandException

Connect client to service. In case of FileService get first netty tcp endpoint or netty http endpoint if no netty tcp endpoint is available

Parameters:

service - the service

Returns:

the sC mgmt client

Throws:

WebCommandException - the web command exception

getParameterInt

protected int getParameterInt(IWebRequest request,
 String name,
 int defaultValue)

Gets the parameter int.

Parameters:

request - the request

name - the name

defaultValue - the default value

Returns:

the parameter int

writePagingAttributes

protected AbstractXMLLoader.Paging writePagingAttributes(XMLStreamWriter writer,
 IWebRequest request,
 int size,
 String prefix)
                                                  throws Exception

Write paging attributes.

Parameters:

writer - the writer

request - the request

size - the size

Returns:

the paging

Throws:

Exception - the exception

writeXMLDate

protected Date writeXMLDate(XMLStreamWriter writer,
 IWebRequest request)
                     throws XMLStreamException

Throws:

XMLStreamException