org.mmbase.bridge.remote.proxy

Class RemoteAuthenticationData_Proxy

java.lang.Object

org.mmbase.bridge.remote.proxy.MappedObject_Proxy<RemoteAuthenticationData>

org.mmbase.bridge.remote.proxy.RemoteAuthenticationData_Proxy

All Implemented Interfaces:

MappedObject, AuthenticationData

public class RemoteAuthenticationData_Proxy
extends MappedObject_Proxy<RemoteAuthenticationData>
implements AuthenticationData

RemoteAuthenticationData_Proxy in a generated smart proxy of AuthenticationData
This smart proxy is used by a local class when the MMCI is called remotely

Author:

generated by org.mmbase.mojo.remote.ProxyGenerator

Field Summary

Fields inherited from interface org.mmbase.security.AuthenticationData

METHOD_ANONYMOUS, METHOD_ASIS, METHOD_DEFAULT, METHOD_DELEGATE, METHOD_HTTP, METHOD_LOGINPAGE, METHOD_LOGOUT, METHOD_PAGELOGON, METHOD_SESSIONDELEGATE, METHOD_SESSIONLOGON, METHOD_UNSET, PARAMETER_AUTHENTICATE, PARAMETER_LOGOUT, PARAMETER_PASSWORD, PARAMETER_RANK, PARAMETER_SESSIONNAME, PARAMETER_USERNAME, PARAMETER_USERNAMES, STORES_CONTEXT_IN_OWNER, STRINGS

Constructor Summary

Constructors

Constructor and Description
RemoteAuthenticationData_Proxy(RemoteAuthenticationData remoteObject)

Method Summary

Modifier and Type	Method and Description
Parameters	createParameters(String arg0) For a given authentication type returns a parameters object to fill with credentials.
Object	getAttribute(String arg0) Allows the user to retrieve specific attributes on the underlying implementation.
int	getDefaultMethod(String arg0) The security implementation can override a default method.
int	getMethod(String arg0) Several 'methods' to authenticate could be available.
int	getNode(UserContext arg0) This method returns an MMBase node that corresponds with the given UserContext
String[]	getTypes() Gives all available authentication types.
String[]	getTypes(int arg0) For a given method, returns the available 'applications'.
String	getUserBuilder() This method returns the builder name of the nodes that will be returned by the AuthenticationData.getNode(UserContext) call.
RemoteAuthenticationData	getWrappedObject()
boolean	isValid(UserContext arg0) The method returns whether the UserContext has become invalid for some reason (change in security config?)

Methods inherited from class org.mmbase.bridge.remote.proxy.MappedObject_Proxy

equals, getMapperCode, hashCode, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RemoteAuthenticationData_Proxy

public RemoteAuthenticationData_Proxy(RemoteAuthenticationData remoteObject)

Method Detail

createParameters

public Parameters createParameters(String arg0)

Description copied from interface: AuthenticationData

For a given authentication type returns a parameters object to fill with credentials. Parameters.toMap(java.util.Map<java.lang.String, java.lang.Object>) can be used as the second argument for Authentication.login(java.lang.String, java.util.Map<java.lang.String, ?>, java.lang.Object[]) Given a certain 'application' this will return a Parameters which tells you exactly which parameters you can and must supply to Authentication.login(String, java.util.Map, Object[]).

Specified by:

createParameters in interface AuthenticationData

getUserBuilder

public String getUserBuilder()

Description copied from interface: AuthenticationData

This method returns the builder name of the nodes that will be returned by the AuthenticationData.getNode(UserContext) call.

Specified by:

getUserBuilder in interface AuthenticationData

getDefaultMethod

public int getDefaultMethod(String arg0)

Description copied from interface: AuthenticationData

The security implementation can override a default method. The default default method (as implemented in Authentication for the 'http' protocol is HTTP (which means that basic authentication of the http protocol can be used), but may not be feasible for every implementation (it is e.g. useless if the security implementation does not have name/password authentication).

Specified by:

getDefaultMethod in interface AuthenticationData

Parameters:

arg0 - For which protocol or null, which means 'for HTTP/1.1'.

getTypes

public String[] getTypes(int arg0)

Description copied from interface: AuthenticationData

For a given method, returns the available 'applications'. The first one can be used as the default.

Typically for the method AuthenticationData.METHOD_ANONYMOUS at least 'anonymous' must be returned, and for AuthenticationData.METHOD_DELEGATE at least 'class'. Everything else is optional, because are not generic.

Specified by:

getTypes in interface AuthenticationData

getTypes

public String[] getTypes()

Description copied from interface: AuthenticationData

Gives all available authentication types. The first one can be used as the default. Typically, an implementation should at least support 'anonynmous' and 'class'.

Since most of the time we are using HTTP any way, types for the method AuthenticationData.METHOD_HTTP ('name/password' based) and method AuthenticationData.METHOD_LOGINPAGE (AuthenticationData.createParameters(java.lang.String) can request anything presentable in a HTML-form) are common too.

Specified by:

getTypes in interface AuthenticationData

isValid

public boolean isValid(UserContext arg0)

Description copied from interface: AuthenticationData

The method returns whether the UserContext has become invalid for some reason (change in security config?)

Specified by:

isValid in interface AuthenticationData

Parameters:

arg0 - The UserContext of which we want to know the rights

Returns:

true when valid, otherwise false

getAttribute

public Object getAttribute(String arg0)

Description copied from interface: AuthenticationData

Allows the user to retrieve specific attributes on the underlying implementation.

Specified by:

getAttribute in interface AuthenticationData

getMethod

public int getMethod(String arg0)

Description copied from interface: AuthenticationData

Several 'methods' to authenticate could be available. A method is a kind of protocol which must be used to authenticate some body.

Not all authentication methods may be applicable for all communication protocols (like http, https etc).

This method converts a user-friendly string describing the 'method' to a integer constant which can be used in AuthenticationData.getTypes(int).

Specified by:

getMethod in interface AuthenticationData

Parameters:

arg0 - A String like 'http', 'anonymous', 'loginpage', or 'delegatesession'.

Returns:

An integer contant. AuthenticationData.METHOD_DELEGATE, AuthenticationData.METHOD_PAGELOGON, AuthenticationData.METHOD_HTTP, AuthenticationData.METHOD_ASIS, AuthenticationData.METHOD_LOGOUT, AuthenticationData.METHOD_LOGINPAGE AuthenticationData.METHOD_SESSIONDELEGATE, AuthenticationData.METHOD_SESSIONLOGON. This method was introduced before java 1.5 (where the return type would more obviously be a AuthenticionMethod enumeration).

See Also:

AuthenticationData.getDefaultMethod(java.lang.String)

getNode

public int getNode(UserContext arg0)

Description copied from interface: AuthenticationData

This method returns an MMBase node that corresponds with the given UserContext

Specified by:

getNode in interface AuthenticationData

getWrappedObject

public RemoteAuthenticationData getWrappedObject()

Specified by:

getWrappedObject in interface MappedObject

Overrides:

getWrappedObject in class MappedObject_Proxy<RemoteAuthenticationData>