uk.ac.soton.itinnovation.grid.service.utils.webadmin
Class WebConfigBase

java.lang.Object
  uk.ac.soton.itinnovation.grid.service.utils.webadmin.AbstractWebConfigBase
      uk.ac.soton.itinnovation.grid.service.utils.webadmin.WebConfigBase

All Implemented Interfaces:

WebAdmin

public class WebConfigBase
extends AbstractWebConfigBase

A version of AbstractWebConfigBase for Axis 1.

Field Summary

Fields inherited from class uk.ac.soton.itinnovation.grid.service.utils.webadmin.AbstractWebConfigBase

log, out, parentWebAppContext, request, webappClasses, webinf

Constructor Summary

WebConfigBase(HttpServletRequest request, Writer out)

Method Summary

protected void	mergeServiceAtomFeeds(Document feed, String atomFeed, String base) Let each service add any events it wants to the master Atom feed.
protected void	serviceSpecificSetup() Called while displaying the admin page if the base configuration is OK.
boolean	showPublicServices() List all the services, with links to their WSDL.
protected void	showServices(boolean available) Write out HTML listing all the services.
protected void	testBaseConfiguration() This is called whenever the checkConfig() thinks the base system is OK.
protected void	upgradeServices(String oldVersion) Called when upgrading from an older version.

Methods inherited from class uk.ac.soton.itinnovation.grid.service.utils.webadmin.AbstractWebConfigBase

checkConfig, ensurePoliciesDeployed, getAtomFeed, getAtomFeed, getDefaultConfigDir, getUpgradeMessage, getVersionProperty, showFeed, testInvocation, upgradeService

Methods inherited from class java.lang.Object

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

Constructor Detail

WebConfigBase

public WebConfigBase(HttpServletRequest request,
                     Writer out)

Method Detail

upgradeServices

protected void upgradeServices(String oldVersion)
                        throws Stop

Description copied from class: AbstractWebConfigBase

Called when upgrading from an older version.

Specified by:

upgradeServices in class AbstractWebConfigBase

Throws:

Stop

serviceSpecificSetup

protected void serviceSpecificSetup()
                             throws Exception

Description copied from class: AbstractWebConfigBase

Called while displaying the admin page if the base configuration is OK. This should perform any service-specific tests or setup, including any test invocation.

Specified by:

serviceSpecificSetup in class AbstractWebConfigBase

Throws:

Exception

testBaseConfiguration

protected void testBaseConfiguration()
                              throws Stop,
                                     Exception

This is called whenever the checkConfig() thinks the base system is OK. It should perform any further checks. If this method throws an exception then the user won't be able to access the individual services, but will be forced to fix the base configuration first. It should call testInvocation() at some point. When this returns successfully during an upgrade, the upgrade is considered successful and the new version number is written.

Throws:

Stop

Exception

showServices

protected void showServices(boolean available)
                     throws IOException

Description copied from class: AbstractWebConfigBase

Write out HTML listing all the services.

Specified by:

showServices in class AbstractWebConfigBase

Parameters:

available - whether the links should be clickable (i.e. whether the base configuration has been compeleted yet)

Throws:

IOException

showPublicServices

public boolean showPublicServices()
                           throws IOException

Description copied from class: AbstractWebConfigBase

List all the services, with links to their WSDL.

Specified by:

showPublicServices in class AbstractWebConfigBase

Returns:

true if the list was displayed, or false if the services aren't configured yet

Throws:

IOException

mergeServiceAtomFeeds

protected void mergeServiceAtomFeeds(Document feed,
                                     String atomFeed,
                                     String base)
                              throws Exception

Description copied from class: AbstractWebConfigBase

Let each service add any events it wants to the master Atom feed.

Specified by:

mergeServiceAtomFeeds in class AbstractWebConfigBase

Parameters:

feed - the feed so far

atomFeed - the URL of the atom feed being generated

base - the base URL for this web-app

Throws:

Exception