[JAVA] Créer une API XML-RPC avec Wicket

environnement

• Wicket 7.10
• Tomcat 8
• Java 8
• org.apache.xmlrpc 3.1.3

Contexte

Je veux faire du XML-RPC avec Wicket!

Préparer une page pour recevoir XML-RPC

• Ignorer la réponse, détacher

XmlRpcPage.java

public class XmlRpcPage extends WebPage {

	private static final long serialVersionUID = 1L;

	public XmlRpcPage(PageParameters params) {
		super(params);
		setStatelessHint(true);
		Session.get().bind();

		HttpServletRequest request = (HttpServletRequest)getRequestCycle().getRequest().getContainerRequest();
		HttpServletResponse response = (HttpServletResponse)getRequestCycle().getResponse().getContainerResponse();

		getRequestCycle().replaceAllRequestHandlers(new IRequestHandler() {

			@Override
			public void respond(IRequestCycle requestCycle) {
				try {
					processXmlRpcRequest(request, response);
				} catch (ServletException | IOException e) {
					throw new WicketRuntimeException(e);
				}
			}

			@Override
			public void detach(IRequestCycle requestCycle) {

			}

		});
	}

	/**
	 * Get XML-RPC server
	 * @return
	 */
	protected XmlRpcServletServer getXmlRpcServer() {
		return ((WicketApplication)getApplication()).getXmlRpcServer();
	}

	/**
	 * Process XML-RPC request
	 * @param request
	 * @param response
	 * @throws ServletException
	 * @throws IOException
	 */
	protected void processXmlRpcRequest(HttpServletRequest request,HttpServletResponse response) throws ServletException, IOException {
		getXmlRpcServer().execute(request, response);
	}

	@Override
	public Markup getAssociatedMarkup() {
		return null;
	}

	@Override
	protected void configureResponse(WebResponse response) {
		final String encoding = getApplication().getRequestCycleSettings().getResponseRequestEncoding();
		response.setContentType("application/xhtml+xml; charset=" + encoding);
	}
}

Paramètres de l'application Wicket

• Serveur pour XmlRpc, prêt pour la configuration

WicketApplication.java

	protected XmlRpcServletServer xmlRpcServer	= null;
	protected XmlRpcServerConfigImpl xmlRpcConfig	= null;

        //constructeur
	public WicketApplication() {
		super();
		xmlRpcServer = new XmlRpcServletServer();
		xmlRpcConfig = new XmlRpcServerConfigImpl();
	}

• Méthode de traitement d'initialisation

WicketApplication.java

	/*
	 * Initialize xmlrpc server
	 */
	public void initXmlRpc() {

		/* configure xml-rpc server */
		xmlRpcServer.setTypeFactory(new CustomTypeFactory(xmlRpcServer));

		//CustomTypeConverterFactory est Xml-Usine pour la conversion de type avec Rpc
		xmlRpcServer.setTypeConverterFactory(new CustomTypeConverterFactory());

		xmlRpcConfig = (XmlRpcServerConfigImpl)this.xmlRpcServer.getConfig();
		xmlRpcConfig.setBasicEncoding(XmlRpcConfigImpl.UTF8_ENCODING);
		xmlRpcConfig.setEnabledForExceptions(true);
		xmlRpcConfig.setEnabledForExtensions(true);

		PropertyHandlerMapping mapping = createXmlRpcHandlerMapping();
		this.xmlRpcServer.setHandlerMapping(mapping);
	}

• CustomTypeFactory * est une extension de org.apache.xmlrpc.common.TypeFactoryImpl

• CustomTypeConverterFactory * est une extension de org.apache.xmlrpc.common.TypeConverterFactoryImpl

• Méthode de mappage Xml-Rpc

WicketApplication.java

	/**
	 * XML-Génération de carte de gestionnaire de propriétés pour RPC
	 * @return
	 */
	private PropertyHandlerMapping createXmlRpcHandlerMapping() {

		PropertyHandlerMapping mapping = new PropertyHandlerMapping();
		mapping.setRequestProcessorFactoryFactory(new StatelessProcessorFactoryFactory());
		mapping.setTypeConverterFactory(new CustomTypeConverterFactory());
		try {
			mapping.load(getClass().getClassLoader(), "xmlrpc.properties");
		} catch (XmlRpcException | IOException e) {
			StringWriter sw = new StringWriter();
			e.printStackTrace(new PrintWriter(sw));
			logger.error("ERROR:\n"+sw.toString());
			throw new WicketRuntimeException(e);
		}
		return mapping;
	}

xmlrpc.properties

SampleService=my.api.xmlrpc.service.impl.SampleServiceImpl

• Appel dans la méthode init

WicketApplication.java

		// initialize XML-RPC
		initXmlRpc();

• Montage de la page après l'initialisation ci-dessus dans la méthode init

WicketApplication.java

		// xml-rpc base
		mount(new MountedMapper("/XmlRpc", XmlRpcPage.class));

appel

TestSampleXmlRpc.java

	public static void main(String[] args) throws Exception {
		
		XmlRpcClientConfigImpl config = new XmlRpcClientConfigImpl();
		config.setServerURL(new URL("http://localhost:8080/sample/XmlRpc"));
		config.setEnabledForExtensions(true);
		config.setEnabledForExceptions(true);

		XmlRpcClient client = new XmlRpcClient();
		client.setTransportFactory(new XmlRpcLoggingTransportFactory(client));
		client.setTypeFactory(new CustomTypeFactory(client));
		client.setConfig(config);

		Vector<Object> arg = new Vector<Object>();
		arg.add("some.parameter");

		Object response = client.execute("SampleService.sampleMethod", arg);
		System.out.println("Response: " + response);
	}

• CustomTypeFactory * est une extension de org.apache.xmlrpc.common.TypeFactoryImpl

Autre

Si vous avez des questions, n'hésitez pas à nous contacter. Pour la gestion des erreurs, essayez ~ catch intercepte tout et renvoie le résultat sous forme de valeur de retour. (Je pensais l'écrire plus tard, mais ce n'est pas quelque chose que j'ai pris la peine d'écrire ...)