com.planet_ink.coffee_mud.WebMacros
Class Authenticate

java.lang.Object
  com.planet_ink.coffee_mud.WebMacros.StdWebMacro
      com.planet_ink.coffee_mud.WebMacros.Authenticate

All Implemented Interfaces:

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

public class Authenticate
extends StdWebMacro

Field Summary

protected static java.lang.String	ABCs
protected static java.lang.String	FILTER

Constructor Summary

Authenticate()

Method Summary

protected static char	ABCeq(char C)
protected static int	ABCindex(char C)
static boolean	authenticated(ExternalHTTPRequests httpReq, java.lang.String login, java.lang.String password)
protected static java.lang.String	Decrypt(java.lang.String DECRYPTME)
protected static java.lang.String	Encrypt(java.lang.String ENCRYPTME)
static java.lang.String	getLogin(ExternalHTTPRequests httpReq)
static java.lang.String	getPassword(ExternalHTTPRequests httpReq)
boolean	isAdminMacro() Whether this macro is restricted to the admin web server.
java.lang.String	name() The public name of this macro
java.lang.String	runMacro(ExternalHTTPRequests httpReq, java.lang.String parm) This method is executed only if this macro returns false for preferBinary().

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

clearWebMacros, clearWebMacros, colorwebifyOnly, compareTo, copyOf, getFilename, getSpecialContentHeader, helpHelp, helpHelp, htmlIncomingFilter, htmlIncomingFilter, htmlOutgoingFilter, htmlOutgoingFilter, ID, initializeClass, isAWebPath, newInstance, parseOrderedParms, parseParms, preferBinary, runBinaryMacro, webify

Methods inherited from class java.lang.Object

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

Field Detail

ABCs

protected static final java.lang.String ABCs

See Also:

Constant Field Values

FILTER

protected static final java.lang.String FILTER

See Also:

Constant Field Values

Constructor Detail

Authenticate

public Authenticate()

Method Detail

name

public java.lang.String name()

Description copied from interface: WebMacro

The public name of this macro

Specified by:

name in interface WebMacro

Overrides:

name in class StdWebMacro

Returns:

The public name of this macro

isAdminMacro

public boolean isAdminMacro()

Description copied from interface: WebMacro

Whether this macro is restricted to the admin web server.

Specified by:

isAdminMacro in interface WebMacro

Overrides:

isAdminMacro in class StdWebMacro

Returns:

true if the macro is restricted to the admin web server

runMacro

public java.lang.String runMacro(ExternalHTTPRequests httpReq,
                                 java.lang.String parm)

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.

Specified by:

runMacro in interface WebMacro

Overrides:

runMacro in class StdWebMacro

Parameters:

httpReq - the external requests object

parm - any parameter strigs given to the macro

Returns:

the string result of running this macro

See Also:

WebMacro.preferBinary(), ExternalHTTPRequests

authenticated

public static boolean authenticated(ExternalHTTPRequests httpReq,
                                    java.lang.String login,
                                    java.lang.String password)

ABCeq

protected static char ABCeq(char C)

ABCindex

protected static int ABCindex(char C)

Encrypt

protected static java.lang.String Encrypt(java.lang.String ENCRYPTME)

Decrypt

protected static java.lang.String Decrypt(java.lang.String DECRYPTME)

getLogin

public static java.lang.String getLogin(ExternalHTTPRequests httpReq)

getPassword

public static java.lang.String getPassword(ExternalHTTPRequests httpReq)