org.benow.web.dev
Interface WebDevelopmentService

All Superinterfaces:
org.benow.java.spec.Markup, org.benow.service.Service
All Known Implementing Classes:
WebDevServiceImpl

public interface WebDevelopmentService
extends org.benow.service.Service


Nested Class Summary
 
Nested classes/interfaces inherited from interface org.benow.java.spec.Markup
org.benow.java.spec.Markup.ParamName, org.benow.java.spec.Markup.ReturnDescription
 
Field Summary
static org.benow.security.permission.Permission PERM_INVOKE
           
 
Method Summary
 void createItem(java.lang.String type, java.lang.String item)
           
 void createTemplate(java.lang.String page, java.lang.String template)
           
 void createTemplateWithRepoFetch(java.lang.String page, java.lang.String template, java.lang.Class<?> classToFetch, java.lang.String keyParam, java.lang.String destTemplate)
           
 void createTemplateWithServiceCall(java.lang.String page, java.lang.String template, java.lang.Class<? extends org.benow.service.Service> serviceClass, java.lang.String sig, java.lang.String destTemplate)
          Creates a new template containing a service call.
 java.lang.String getItem(java.lang.String type, java.lang.String item, boolean confirmExtract, boolean confirmExternal)
          Gets a named item of a given type.
 java.util.List<XMLChunk> getLastXML()
           
 java.util.List<java.lang.String> getMaintainableItems(java.lang.String type, boolean includeResources)
           
 java.util.List<org.benow.repository.jdbc.ClassSchemaInfo> getRepoClasses()
          Get info for all classes stored in repository
 java.util.List<org.benow.java.packager.resource.ResourceEntry> getResources()
           
 org.benow.java.spec.ServiceSpecification getService(java.lang.String name)
           
 StylesheetInfo getXSLInfo(java.lang.String path)
           
 void updateItem(java.lang.String type, java.lang.String item, java.lang.String code)
           
 

Field Detail

PERM_INVOKE

static final org.benow.security.permission.Permission PERM_INVOKE
Method Detail

getItem

java.lang.String getItem(java.lang.String type,
                         java.lang.String item,
                         boolean confirmExtract,
                         boolean confirmExternal)
                         throws java.io.IOException,
                                org.benow.repository.NoSuchObjectException,
                                BundledInResourceException,
                                IsExternalFileException
Gets a named item of a given type. Items in resources (ie jars) can be extracted by passing true for confirmExtract. If false is passed, resources which do not exist as local files cause a BundledInResourceException (as they may not be taken).

Parameters:
type - type of item to get
item - name of item
confirmExtract - true to extract from resource, or false to throw BundledInResourceException and not extract
Returns:
Throws:
java.io.IOException
org.benow.repository.NoSuchObjectException
BundledInResourceException - when the item is found to be in a resource bundle (jar)
IsExternalFileException - when the item is found to not exist within the current directory, but is a file elsewhere

updateItem

void updateItem(java.lang.String type,
                java.lang.String item,
                java.lang.String code)
                throws java.io.IOException,
                       org.benow.repository.NoSuchObjectException,
                       RedirectException,
                       javax.xml.transform.TransformerException
Throws:
java.io.IOException
org.benow.repository.NoSuchObjectException
RedirectException
javax.xml.transform.TransformerException

getService

org.benow.java.spec.ServiceSpecification getService(java.lang.String name)
                                                    throws org.benow.java.spec.SpecificationException,
                                                           java.lang.ClassNotFoundException
Throws:
org.benow.java.spec.SpecificationException
java.lang.ClassNotFoundException

getLastXML

java.util.List<XMLChunk> getLastXML()

createItem

void createItem(java.lang.String type,
                java.lang.String item)
                throws java.io.FileNotFoundException,
                       java.io.IOException,
                       org.benow.repository.NoSuchObjectException
Throws:
java.io.FileNotFoundException
java.io.IOException
org.benow.repository.NoSuchObjectException

getMaintainableItems

java.util.List<java.lang.String> getMaintainableItems(java.lang.String type,
                                                      boolean includeResources)
                                                      throws org.benow.repository.NoSuchObjectException
Throws:
org.benow.repository.NoSuchObjectException

createTemplateWithServiceCall

void createTemplateWithServiceCall(java.lang.String page,
                                   java.lang.String template,
                                   java.lang.Class<? extends org.benow.service.Service> serviceClass,
                                   java.lang.String sig,
                                   java.lang.String destTemplate)
                                   throws java.io.FileNotFoundException,
                                          javax.xml.transform.TransformerException,
                                          TerseWebException,
                                          java.lang.Exception
Creates a new template containing a service call.

Parameters:
page -
template -
serviceClass -
sig -
destTemplate -
Throws:
javax.xml.transform.TransformerException
java.io.FileNotFoundException
java.lang.Exception
TerseWebException

createTemplate

void createTemplate(java.lang.String page,
                    java.lang.String template)
                    throws java.io.IOException,
                           javax.xml.transform.TransformerException,
                           javax.xml.parsers.ParserConfigurationException,
                           org.xml.sax.SAXException,
                           RedirectException
Throws:
java.io.IOException
javax.xml.transform.TransformerException
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
RedirectException

getRepoClasses

java.util.List<org.benow.repository.jdbc.ClassSchemaInfo> getRepoClasses()
Get info for all classes stored in repository

Returns:

createTemplateWithRepoFetch

void createTemplateWithRepoFetch(java.lang.String page,
                                 java.lang.String template,
                                 java.lang.Class<?> classToFetch,
                                 java.lang.String keyParam,
                                 java.lang.String destTemplate)
                                 throws javax.xml.parsers.ParserConfigurationException,
                                        org.xml.sax.SAXException,
                                        java.io.IOException,
                                        javax.xml.transform.TransformerException,
                                        org.benow.java.spec.SpecificationException,
                                        WebException
Throws:
javax.xml.parsers.ParserConfigurationException
org.xml.sax.SAXException
java.io.IOException
javax.xml.transform.TransformerException
org.benow.java.spec.SpecificationException
WebException

getResources

java.util.List<org.benow.java.packager.resource.ResourceEntry> getResources()
                                                                            throws java.io.IOException
Throws:
java.io.IOException

getXSLInfo

StylesheetInfo getXSLInfo(java.lang.String path)
                          throws java.io.FileNotFoundException,
                                 java.io.IOException,
                                 java.lang.Exception
Throws:
java.io.FileNotFoundException
java.io.IOException
java.lang.Exception