com.google.api.client.extensions.jetty.auth.oauth2

Class LocalServerReceiver

java.lang.Object

com.google.api.client.extensions.jetty.auth.oauth2.LocalServerReceiver

All Implemented Interfaces:

VerificationCodeReceiver

public final class LocalServerReceiver
extends Object
implements VerificationCodeReceiver

OAuth 2.0 verification code receiver that runs a Jetty server on a free port, waiting for a redirect with the verification code.

Implementation is thread-safe.

Since:

1.11

Author:

Yaniv Inbar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LocalServerReceiver.Builder Builder.

Constructor Summary

Constructors

Constructor and Description
LocalServerReceiver() Constructor that starts the server on LOCALHOST and an unused port.

Method Summary

Modifier and Type	Method and Description
String	getCallbackPath() Returns callback path used in redirect_uri.
String	getHost() Returns the host name to use.
int	getPort() Returns the port to use or -1 to select an unused port in getRedirectUri().
String	getRedirectUri() Returns the redirect URI.
void	stop() Releases any resources and stops any processes started.
String	waitForCode() Blocks until the server receives a login result, or the server is stopped by stop(), to return an authorization code.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

LocalServerReceiver

public LocalServerReceiver()

Constructor that starts the server on LOCALHOST and an unused port.

Use LocalServerReceiver.Builder if you need to specify any of the optional parameters.

Method Detail

getRedirectUri

public String getRedirectUri()
                      throws IOException

Description copied from interface: VerificationCodeReceiver

Returns the redirect URI.

Specified by:

getRedirectUri in interface VerificationCodeReceiver

Throws:

IOException

waitForCode

public String waitForCode()
                   throws IOException

Blocks until the server receives a login result, or the server is stopped by stop(), to return an authorization code.

Specified by:

waitForCode in interface VerificationCodeReceiver

Returns:

authorization code if login succeeds; may return null if the server is stopped by stop()

Throws:

IOException - if the server receives an error code (through an HTTP request parameter error)

stop

public void stop()
          throws IOException

Description copied from interface: VerificationCodeReceiver

Releases any resources and stops any processes started.

Specified by:

stop in interface VerificationCodeReceiver

Throws:

IOException

getHost

public String getHost()

Returns the host name to use.

getPort

public int getPort()

Returns the port to use or -1 to select an unused port in getRedirectUri().

getCallbackPath

public String getCallbackPath()

Returns callback path used in redirect_uri.