public abstract class AbstractReflectiveHandlerMapping extends Object implements XmlRpcListableHandlerMapping
Modifier and Type | Class and Description |
---|---|
static interface |
AbstractReflectiveHandlerMapping.AuthenticationHandler
An object implementing this interface may be used
to validate user names and passwords.
|
Modifier and Type | Field and Description |
---|---|
protected Map |
handlerMap |
Constructor and Description |
---|
AbstractReflectiveHandlerMapping() |
Modifier and Type | Method and Description |
---|---|
AbstractReflectiveHandlerMapping.AuthenticationHandler |
getAuthenticationHandler()
Returns the authentication handler, if any, or null.
|
XmlRpcHandler |
getHandler(String pHandlerName)
Returns the
XmlRpcHandler with the given name. |
String[] |
getListMethods()
This method implements the introspection method
system.listMethods , which is specified
as follows:
|
protected String |
getMethodHelp(Class pClass,
Method[] pMethods)
Creates a help string for the given method, when applied
to the given class.
|
String |
getMethodHelp(String pHandlerName)
This method implements the introspection method
system.methodSignature , which is specified
as follows:
|
String[][] |
getMethodSignature(String pHandlerName)
This method implements the introspection method
system.methodSignature , which is specified
as follows:
|
RequestProcessorFactoryFactory |
getRequestProcessorFactoryFactory()
Returns the mappings
RequestProcessorFactoryFactory . |
protected String[][] |
getSignature(Method[] pMethods)
Creates a signature for the given method.
|
TypeConverterFactory |
getTypeConverterFactory()
Returns the mappings
TypeConverterFactory . |
protected boolean |
isHandlerMethod(Method pMethod) |
boolean |
isVoidMethodEnabled()
Returns, whether void methods are enabled.
|
protected XmlRpcHandler |
newXmlRpcHandler(Class pClass,
Method[] pMethods)
Creates a new instance of
XmlRpcHandler . |
protected void |
registerPublicMethods(String pKey,
Class pType)
Searches for methods in the given class.
|
void |
setAuthenticationHandler(AbstractReflectiveHandlerMapping.AuthenticationHandler pAuthenticationHandler)
Sets the authentication handler, if any, or null.
|
void |
setRequestProcessorFactoryFactory(RequestProcessorFactoryFactory pFactory)
Sets the mappings
RequestProcessorFactoryFactory . |
void |
setTypeConverterFactory(TypeConverterFactory pFactory)
Sets the mappings
TypeConverterFactory . |
void |
setVoidMethodEnabled(boolean pVoidMethodEnabled)
Sets, whether void methods are enabled.
|
protected Map handlerMap
public void setTypeConverterFactory(TypeConverterFactory pFactory)
TypeConverterFactory
.public TypeConverterFactory getTypeConverterFactory()
TypeConverterFactory
.public void setRequestProcessorFactoryFactory(RequestProcessorFactoryFactory pFactory)
RequestProcessorFactoryFactory
. Note, that this doesn't
affect already registered handlers.public RequestProcessorFactoryFactory getRequestProcessorFactoryFactory()
RequestProcessorFactoryFactory
.public AbstractReflectiveHandlerMapping.AuthenticationHandler getAuthenticationHandler()
public void setAuthenticationHandler(AbstractReflectiveHandlerMapping.AuthenticationHandler pAuthenticationHandler)
protected boolean isHandlerMethod(Method pMethod)
protected void registerPublicMethods(String pKey, Class pType) throws XmlRpcException
XmlRpcHandler
.
Valid methods are defined as follows:
Object
.pKey
- Suffix for building handler names. A dot and
the method name are being added.pType
- The class being inspected.XmlRpcException
protected XmlRpcHandler newXmlRpcHandler(Class pClass, Method[] pMethods) throws XmlRpcException
XmlRpcHandler
.pClass
- The class, which was inspected for handler
methods. This is used for error messages only. Typically,
it is the same than pInstance.getClass().
pMethods
- The method being invoked.XmlRpcException
protected String[][] getSignature(Method[] pMethods)
protected String getMethodHelp(Class pClass, Method[] pMethods)
public XmlRpcHandler getHandler(String pHandlerName) throws XmlRpcNoSuchHandlerException, XmlRpcException
XmlRpcHandler
with the given name.getHandler
in interface XmlRpcHandlerMapping
pHandlerName
- The handlers nameXmlRpcNoSuchHandlerException
- A handler with the given
name is unknown.XmlRpcException
- An internal error occurred.public String[] getListMethods() throws XmlRpcException
XmlRpcListableHandlerMapping
system.listMethods
, which is specified
as follows:
This method may be used to enumerate the methods implemented by the XML-RPC server.
The system.listMethods
method requires no
parameters. It returns an array of strings, each of which is
the name of a method implemented by the server.
Note, that the specification doesn't require that the list
must be exhaustive. We conclude, that a valid method
"handlerName" doesn't need to be in the list. For example,
a handler, which implements XmlRpcHandler
, but not
XmlRpcMetaDataHandler
, should possibly excluded:
Otherwise, the listable handler mapping could not provide
meaningful replies to system.methodSignature
,
and system.methodHelp
.
getListMethods
in interface XmlRpcListableHandlerMapping
XmlRpcException
- An internal error occurred.public String getMethodHelp(String pHandlerName) throws XmlRpcException
XmlRpcListableHandlerMapping
system.methodSignature
, which is specified
as follows:
This method takes one parameter, the name of a method implemented by the XML-RPC server. It returns a documentation string describing the use of that method. If no such string is available, an empty string is returned.
The documentation string may contain HTML markup.
getMethodHelp
in interface XmlRpcListableHandlerMapping
XmlRpcException
public String[][] getMethodSignature(String pHandlerName) throws XmlRpcException
XmlRpcListableHandlerMapping
system.methodSignature
, which is specified
as follows:
This method takes one parameter, the name of a method implemented by the XML-RPC server. It returns an array of possible signatures for this method. A signature is an array of types. The first of these types is the return type of the method, the rest are parameters.
Multiple signatures (ie. overloading) are permitted: this is the reason that an array of signatures are returned by this method.
Signatures themselves are restricted to the top level parameters expected by a method. For instance if a method expects one array of structs as a parameter, and it returns a string, its signature is simply "string, array". If it expects three integers, its signature is "string, int, int, int".
If no signature is defined for the method, a none-array value is returned. Therefore this is the way to test for a non-signature, if $resp below is the response object from a method call to system.methodSignature:
$v=$resp->value(); if ($v->kindOf()!="array") { // then the method did not have a signature defined }See the introspect.php demo included in this distribution for an example of using this method.
getMethodSignature
in interface XmlRpcListableHandlerMapping
XmlRpcException
XmlRpcMetaDataHandler.getSignatures()
public boolean isVoidMethodEnabled()
public void setVoidMethodEnabled(boolean pVoidMethodEnabled)
Copyright © 2001–2016 The Apache Software Foundation. All rights reserved.