Question

According to the Remote API docs for Java, the Remote API servlet needs to be mapped to the /remote_api URL.

If I map the servlet to a different URL, would it be possible to use the Remote API classes in a client side script? I can’t find the javadoc for this, and the examples in the above doc don’t cover this case.

Answer 1

In order to enable Remote API in your application, you need to add the following in your web.xml file:

<servlet>
    <display-name>Remote API Servlet</display-name>
    <servlet-name>RemoteApiServlet</servlet-name>
    <servlet-class>com.google.apphosting.utils.remoteapi.RemoteApiServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>RemoteApiServlet</servlet-name>
    <url-pattern>/remote_api</url-pattern>
</servlet-mapping>

As you see, in the above code snippet the RemoteApiServlet is mapped to the /remote_api url. However, it is not mandatory to use this url. In the mapping, you could use your own url. For example, you could have:

<servlet>
    <display-name>Remote API Servlet</display-name>
    <servlet-name>RemoteApiServlet</servlet-name>
    <servlet-class>com.google.apphosting.utils.remoteapi.RemoteApiServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
</servlet>
<servlet-mapping>
    <servlet-name>RemoteApiServlet</servlet-name>
    <url-pattern>/myurl</url-pattern>
</servlet-mapping>

Update: Code for the client

In the client, based on the documentation provided at Configuring Remote API on a Standalone Client, you can set the custom path by modifying the RemoteApiOptions. For example:

RemoteApiOptions options = new RemoteApiOptions()
    .server("your_app_id.appspot.com", 443)
    .credentials(username, password)
    .remoteApiPath(yourpath);

Hope this helps!