unidue.ub.statistics.frontend

Class FachRefServlet

java.lang.Object

javax.servlet.GenericServlet

javax.servlet.http.HttpServlet

org.mycore.frontend.servlets.MCRServlet

unidue.ub.statistics.frontend.FachRefServlet

All Implemented Interfaces:

java.io.Serializable, javax.servlet.Servlet, javax.servlet.ServletConfig

Direct Known Subclasses:

AdminOverviewServlet, AlertDefineServlet, AlertDeleteServlet, AlertManagementServlet, AnchorOrderDefineServlet, AnchorOrderDeleteServlet, AnchorOrderManagementServlet, AskSushiServlet, BudgetCollectorServlet, CollectionDAO, CollectionDefineServlet, CSVCollectorServlet, DeletionAssistantServlet, DocumentServlet, EMediaStartServlet, HelpStartServlet, IgnoredDeleteServlet, IgnoredManagementServlet, IgnoredServlet, JournalCollectionMetricsServlet, JournalMetricsServlet, JournalOverviewServlet, JournalTitleManagementServlet, JournalUsageServlet, LibraryDisplayServlet, NotationDAO, NRequestsCollector, NRequestsServlet, PackageDeleteServlet, PackageManagementServlet, PriceExtenderServlet, ProtokollServlet, PurchaseAssistantServlet, SCPDefineServlet, SCPDeleteServlet, SCPManagementServlet, ShelfAnalyzerServlet, SNIPExtenderServlet, StartServlet, StockAnalysisAssistantServlet, StockAnalyzerServlet, StockUsageAnalysisServlet, SubjectDistributorServlet, SushiProviderDefineServlet, SushiProviderDeleteServlet, SushiProviderManagementServlet, UsageServlet, UserAdminServlet, UserManagementServlet, UserPasswordChangeServlet, UserRegistrationServlet, YearExtenderServlet

public class FachRefServlet
extends org.mycore.frontend.servlets.MCRServlet

Extends the MCRServlet by some functionality to ease the handling of request parameters.

Version:

1

Author:

Eike Spielberg

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
FachRefServlet()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getParameter(org.mycore.frontend.servlets.MCRServletJob job, java.lang.String name) Takes the HTTP-Request from the MCRServletJob and retrieves the parameter.
static org.jdom2.Element	prepareOutput(org.mycore.frontend.servlets.MCRServletJob job, java.lang.String outputName) Prepares the basic output with a given root element name and the friendly name and the current timestamp
static org.jdom2.Element	prepareOutput(org.mycore.frontend.servlets.MCRServletJob job, java.lang.String outputName, java.lang.String module) Prepares the basic output with a given root element name and the friendly name and the current timestamp
static org.jdom2.Element	prepareOutput(org.mycore.frontend.servlets.MCRServletJob job, java.lang.String outputName, java.lang.String module, java.lang.String function) Prepares the basic output with a given root element name and the friendly name and the current timestamp
static void	sendOutput(org.mycore.frontend.servlets.MCRServletJob job, org.jdom2.Element output) renders and sends the prepared output XML to the HTTP response

Methods inherited from class org.mycore.frontend.servlets.MCRServlet

doGet, doPost, encodeURL, getLayoutService, getProperty, getServletBaseURL, getSession, init

Methods inherited from class javax.servlet.http.HttpServlet

service

Methods inherited from class javax.servlet.GenericServlet

destroy, getInitParameter, getInitParameterNames, getServletConfig, getServletContext, getServletInfo, getServletName, init, log, log

Methods inherited from class java.lang.Object

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

Constructor Detail

FachRefServlet

public FachRefServlet()

Method Detail

getParameter

public static java.lang.String getParameter(org.mycore.frontend.servlets.MCRServletJob job,
                                            java.lang.String name)

Takes the HTTP-Request from the MCRServletJob and retrieves the parameter.

Parameters:

name - the name of the parameter

job - MCRServletJob

name - the name of the parameter from the HTML request

Returns:

String the desired parameter from the MCRServletJob. If the parameter is not found,an empty string is returned

prepareOutput

public static org.jdom2.Element prepareOutput(org.mycore.frontend.servlets.MCRServletJob job,
                                              java.lang.String outputName)

Prepares the basic output with a given root element name and the friendly name and the current timestamp

Parameters:

job - MCRServletJob

outputName - the name of the root element for the output

Returns:

an org.jdom2.element acting as root element for the output

prepareOutput

public static org.jdom2.Element prepareOutput(org.mycore.frontend.servlets.MCRServletJob job,
                                              java.lang.String outputName,
                                              java.lang.String module)

Prepares the basic output with a given root element name and the friendly name and the current timestamp

Parameters:

job - MCRServletJob

outputName - the name of the root element for the output

module - the name of the module

Returns:

an org.jdom2.element acting as root element for the output

prepareOutput

public static org.jdom2.Element prepareOutput(org.mycore.frontend.servlets.MCRServletJob job,
                                              java.lang.String outputName,
                                              java.lang.String module,
                                              java.lang.String function)

Prepares the basic output with a given root element name and the friendly name and the current timestamp

Parameters:

job - MCRServletJob

outputName - the name of the root element for the output

module - the name of the module

function - the name of the function within the module

Returns:

an org.jdom2.element acting as root element for the output

sendOutput

public static void sendOutput(org.mycore.frontend.servlets.MCRServletJob job,
                              org.jdom2.Element output)
                       throws java.io.IOException,
                              javax.xml.transform.TransformerException,
                              org.xml.sax.SAXException

renders and sends the prepared output XML to the HTTP response

Parameters:

job - MCRServletJob

output - org.jdom2.element acting as output

Throws:

java.io.IOException - thrown while writing the output to the HTTP response

javax.xml.transform.TransformerException - thrown while rendering the output element

org.xml.sax.SAXException - thrown while parsing the output element