public class RemoteApiInstaller
extends java.lang.Object
Instances of this class can only be used on a single thread.
Constructor and Description |
---|
RemoteApiInstaller() |
Modifier and Type | Method and Description |
---|---|
int |
getRpcCount()
Returns the number of RPC calls made since the API was installed
or
resetRpcCount() was called. |
void |
install(RemoteApiOptions options)
Installs the remote API using the provided options.
|
void |
logMethodCalls()
Starts logging remote API method calls to the console.
|
static Cookie |
makeDevAppServerCookie(java.lang.String hostname,
java.lang.String email) |
void |
resetRpcCount() |
java.lang.String |
serializeCredentials()
Returns a string containing the cookies associated with this
connection.
|
void |
uninstall()
Uninstalls the remote API.
|
public void install(RemoteApiOptions options) throws java.io.IOException
Warning: This method only installs the remote API on the current thread. Do not share this instance across threads!
java.lang.IllegalArgumentException
- if the server or credentials weren't provided.java.lang.IllegalStateException
- if already installedLoginException
- if unable to log in.java.io.IOException
- if unable to connect to the remote API.public void uninstall()
If the remote API isn't installed, this method has no effect.
public java.lang.String serializeCredentials()
RemoteApiOptions.reuseCredentials(java.lang.String, java.lang.String)
.
By storing credentials to a file, we can avoid repeated password
prompts in command-line tools. (Note that the cookies will expire
based on the setting under Application Settings in the admin console.)
Beware: it's important to keep this string private, as it allows admin access to the app as the current user.
public void logMethodCalls()
public void resetRpcCount()
public int getRpcCount()
resetRpcCount()
was called.public static Cookie makeDevAppServerCookie(java.lang.String hostname, java.lang.String email)