|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.evernote.edam.userstore.UserStore.Client
public static class UserStore.Client
Field Summary | |
---|---|
protected org.apache.thrift.protocol.TProtocol |
iprot_
|
protected org.apache.thrift.protocol.TProtocol |
oprot_
|
protected int |
seqid_
|
Constructor Summary | |
---|---|
UserStore.Client(org.apache.thrift.protocol.TProtocol prot)
|
|
UserStore.Client(org.apache.thrift.protocol.TProtocol iprot,
org.apache.thrift.protocol.TProtocol oprot)
|
Method Summary | |
---|---|
AuthenticationResult |
authenticate(java.lang.String username,
java.lang.String password,
java.lang.String consumerKey,
java.lang.String consumerSecret)
This is used to check a username and password in order to create an authentication session that could be used for further actions. |
boolean |
checkVersion(java.lang.String clientName,
short edamVersionMajor,
short edamVersionMinor)
This should be the first call made by a client to the EDAM service. |
org.apache.thrift.protocol.TProtocol |
getInputProtocol()
|
org.apache.thrift.protocol.TProtocol |
getOutputProtocol()
|
PublicUserInfo |
getPublicUserInfo(java.lang.String username)
Asks the UserStore about the publicly available location information for a particular username. |
User |
getUser(java.lang.String authenticationToken)
Returns the User corresponding to the provided authentication token, or throws an exception if this token is not valid. |
AuthenticationResult |
recv_authenticate()
|
boolean |
recv_checkVersion()
|
PublicUserInfo |
recv_getPublicUserInfo()
|
User |
recv_getUser()
|
AuthenticationResult |
recv_refreshAuthentication()
|
AuthenticationResult |
refreshAuthentication(java.lang.String authenticationToken)
This is used to take an existing authentication token (returned from 'authenticate') and exchange it for a newer token which will not expire as soon. |
void |
send_authenticate(java.lang.String username,
java.lang.String password,
java.lang.String consumerKey,
java.lang.String consumerSecret)
|
void |
send_checkVersion(java.lang.String clientName,
short edamVersionMajor,
short edamVersionMinor)
|
void |
send_getPublicUserInfo(java.lang.String username)
|
void |
send_getUser(java.lang.String authenticationToken)
|
void |
send_refreshAuthentication(java.lang.String authenticationToken)
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
protected org.apache.thrift.protocol.TProtocol iprot_
protected org.apache.thrift.protocol.TProtocol oprot_
protected int seqid_
Constructor Detail |
---|
public UserStore.Client(org.apache.thrift.protocol.TProtocol prot)
public UserStore.Client(org.apache.thrift.protocol.TProtocol iprot, org.apache.thrift.protocol.TProtocol oprot)
Method Detail |
---|
public org.apache.thrift.protocol.TProtocol getInputProtocol()
public org.apache.thrift.protocol.TProtocol getOutputProtocol()
public boolean checkVersion(java.lang.String clientName, short edamVersionMajor, short edamVersionMinor) throws org.apache.thrift.TException
UserStore.Iface
checkVersion
in interface UserStore.Iface
clientName
- This string provides some information about the client for
tracking/logging on the service. It should provide information about
the client's software and platform. The structure should be:
application/version; platform/version; [ device/version ]
E.g. "Evernote Windows/3.0.1; Windows/XP SP3" or
"Evernote Clipper/1.0.1; JME/2.0; Motorola RAZR/2.0;edamVersionMajor
- This should be the major protocol version that was compiled by the
client. This should be the current value of the EDAM_VERSION_MAJOR
constant for the client.edamVersionMinor
- This should be the major protocol version that was compiled by the
client. This should be the current value of the EDAM_VERSION_MINOR
constant for the client.
org.apache.thrift.TException
public void send_checkVersion(java.lang.String clientName, short edamVersionMajor, short edamVersionMinor) throws org.apache.thrift.TException
org.apache.thrift.TException
public boolean recv_checkVersion() throws org.apache.thrift.TException
org.apache.thrift.TException
public AuthenticationResult authenticate(java.lang.String username, java.lang.String password, java.lang.String consumerKey, java.lang.String consumerSecret) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
UserStore.Iface
authenticate
in interface UserStore.Iface
username
- The username (not numeric user ID) for the account to
authenticate against. This function will also accept the user's
registered email address in this parameter.password
- The plaintext password to check against the account. Since
this is not protected by the EDAM protocol, this information must be
provided over a protected transport (e.g. SSL).consumerKey
- A unique identifier for this client application, provided by Evernote
to developers who request an API key. This must be provided to identify
the client.consumerSecret
- If the client was given a "consumer secret" when the API key was issued,
it must be provided here to authenticate the application itself.
EDAMUserException
- EDAMSystemException
org.apache.thrift.TException
public void send_authenticate(java.lang.String username, java.lang.String password, java.lang.String consumerKey, java.lang.String consumerSecret) throws org.apache.thrift.TException
org.apache.thrift.TException
public AuthenticationResult recv_authenticate() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public AuthenticationResult refreshAuthentication(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
UserStore.Iface
refreshAuthentication
in interface UserStore.Iface
authenticationToken
- The previous authentication token from the authenticate() result.
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public void send_refreshAuthentication(java.lang.String authenticationToken) throws org.apache.thrift.TException
org.apache.thrift.TException
public AuthenticationResult recv_refreshAuthentication() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public User getUser(java.lang.String authenticationToken) throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
UserStore.Iface
getUser
in interface UserStore.Iface
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public void send_getUser(java.lang.String authenticationToken) throws org.apache.thrift.TException
org.apache.thrift.TException
public User recv_getUser() throws EDAMUserException, EDAMSystemException, org.apache.thrift.TException
EDAMUserException
EDAMSystemException
org.apache.thrift.TException
public PublicUserInfo getPublicUserInfo(java.lang.String username) throws EDAMNotFoundException, EDAMSystemException, EDAMUserException, org.apache.thrift.TException
UserStore.Iface
getPublicUserInfo
in interface UserStore.Iface
EDAMUserException
- EDAMNotFoundException
EDAMSystemException
org.apache.thrift.TException
public void send_getPublicUserInfo(java.lang.String username) throws org.apache.thrift.TException
org.apache.thrift.TException
public PublicUserInfo recv_getPublicUserInfo() throws EDAMNotFoundException, EDAMSystemException, EDAMUserException, org.apache.thrift.TException
EDAMNotFoundException
EDAMSystemException
EDAMUserException
org.apache.thrift.TException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |