de.tif.jacob.entrypoint
Interface ICmdEntryPoint

All Superinterfaces:

IEntryPoint

public interface ICmdEntryPoint
extends IEntryPoint

Nested Class Summary

static class

ICmdEntryPoint.PropertyDefinition

Method Summary

void	enter(CmdEntryPointContext context, java.util.Properties properties) The worker function of the entry point.
java.lang.String	getMimeType(CmdEntryPointContext context, java.util.Properties properties) The mime type of the returned document.

Method Detail

getMimeType

java.lang.String getMimeType(CmdEntryPointContext context,
                             java.util.Properties properties)

The mime type of the returned document. A entry point can return different types of documents. If you implement a document provider (download of documents from a DB) you can set the mimetype for each request depending on the handsover properties or the context information.

Parameters:

context - The context of the user client

properties - The hands over properties to the entry point

Returns:

a valid mime type definition. (text/plain or text/html......)

enter

void enter(CmdEntryPointContext context,
           java.util.Properties properties)
           throws java.lang.Exception

The worker function of the entry point.
You must return the content of the entry point in this method.

Example of a simple HTML data table:

   public void   enter(CmdEntryPointContext context, Properties properties) throws IOException
   {
    context.getStream().write("<table>\n".getBytes());
    context.getStream().write("<tr><td>a</td><td>b</td><td>c</td><td>e</td><td>f</td><td>1</td></tr>\n".getBytes());
    context.getStream().write("<tr><td>a</td><td>b</td><td>c</td><td>e</td><td>f</td><td>1</td></tr>\n".getBytes());
    context.getStream().write("</table>\n".getBytes());
    }
   

;

Parameters:

context - The context of the user client

properties - The hands over properties / parameters of the entry point call

Throws:

java.lang.Exception