Package com.planet_ink.coffee_mud.WebMacros

Class AreaXML

java.lang.Object

com.planet_ink.coffee_mud.WebMacros.StdWebMacro

com.planet_ink.coffee_mud.WebMacros.AreaXML

All Implemented Interfaces:

CMObject, WebMacro, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class AreaXML
extends StdWebMacro

Field Summary

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Constructor Summary

Constructors

Constructor	Description
AreaXML()

Method Summary

Modifier and Type	Method	Description
java.lang.String	getFilename(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String filename)
protected Area	getLoggedArea(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, MOB mob)
boolean	isAWebPath()	Whether this macro substitutes as an aspect of the web path instead of a standard web macro.
java.lang.String	name()	The public name of this macro
boolean	preferBinary()	Whether the runMacro or runBinaryMacro executor should be called.
byte[]	runBinaryMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String parm, com.planet_ink.coffee_web.interfaces.HTTPResponse httpResp)	This method is executed only if this macro returns true for preferBinary().
java.lang.String	runMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq, java.lang.String parm, com.planet_ink.coffee_web.interfaces.HTTPResponse httpResp)	This method is executed only if this macro returns false for preferBinary().

Methods inherited from class java.lang.Object

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

Methods inherited from class com.planet_ink.coffee_mud.WebMacros.StdWebMacro

clearWebMacros, clearWebMacros, colorwebifyOnly, compareTo, copyOf, getHTTPFileData, grabFile, helpHelp, helpHelp, htmlIncomingFilter, htmlIncomingFilter, htmlOutgoingFilter, htmlOutgoingFilter, ID, initializeClass, isAdminMacro, L, newInstance, parseOrderedParms, parseParms, parseParms, safeIncomingfilter, webify, webify

Constructor Detail

AreaXML

public AreaXML()

Method Detail

name

public java.lang.String name()

Description copied from interface: WebMacro

The public name of this macro

Specified by:

name in interface CMObject

Specified by:

name in interface WebMacro

Overrides:

name in class StdWebMacro

Returns:

The public name of this macro

See Also:

Environmental.Name()

isAWebPath

public boolean isAWebPath()

Description copied from interface: WebMacro

Whether this macro substitutes as an aspect of the web path instead of a standard web macro. If true is returned, URLs such as: http://mydomain.com/mymacroname?firstparm=value&secondparm=value might succeeed

Specified by:

isAWebPath in interface WebMacro

Overrides:

isAWebPath in class StdWebMacro

Returns:

whether this is a weird URL macro

preferBinary

public boolean preferBinary()

Description copied from interface: WebMacro

Whether the runMacro or runBinaryMacro executor should be called.

Specified by:

preferBinary in interface WebMacro

Overrides:

preferBinary in class StdWebMacro

Returns:

whether the runBinaryMacro executor should be called instead of runMacro

See Also:

WebMacro.runBinaryMacro(HTTPRequest, String, HTTPResponse), WebMacro.runMacro(HTTPRequest, String, HTTPResponse)

getFilename

public java.lang.String getFilename(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                    java.lang.String filename)

getLoggedArea

protected Area getLoggedArea(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                             MOB mob)

runBinaryMacro

public byte[] runBinaryMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                             java.lang.String parm,
                             com.planet_ink.coffee_web.interfaces.HTTPResponse httpResp)
                      throws HTTPServerException

Description copied from interface: WebMacro

This method is executed only if this macro returns true for preferBinary(). It will execute the macro and return its results as a binary byte array. The response object is used to set cookies and headers only. Any response body is in the return object. Since 99% of macros are only filling in an existing page, nothing will be done with that anyway, and is only important when isAWebPath return true.

Specified by:

runBinaryMacro in interface WebMacro

Overrides:

runBinaryMacro in class StdWebMacro

Parameters:

httpReq - the external requests object

parm - any parameter strings given to the macro

httpResp - the response, with headers

Returns:

the binary stream result of running this macro

Throws:

HTTPServerException - a http error to pass to the user

See Also:

WebMacro.preferBinary(), HTTPRequest

runMacro

public java.lang.String runMacro(com.planet_ink.coffee_web.interfaces.HTTPRequest httpReq,
                                 java.lang.String parm,
                                 com.planet_ink.coffee_web.interfaces.HTTPResponse httpResp)
                          throws HTTPServerException

Description copied from interface: WebMacro

This method is executed only if this macro returns false for preferBinary(). It will execute the macro and return its results as a string, which is then substituted for the macro reference in the web page where the macro was found. The response object is used to set cookies and headers only. Any response body is in the return object. Since 99% of macros are only filling in an existing page, nothing will be done with that anyway, and is only important when isAWebPath return true.

Specified by:

runMacro in interface WebMacro

Overrides:

runMacro in class StdWebMacro

Parameters:

httpReq - the external requests object

parm - any parameter strings given to the macro

httpResp - the response, with headers

Returns:

the string result of running this macro

Throws:

HTTPServerException - a http error to pass to the user

See Also:

WebMacro.preferBinary(), HTTPRequest