Field Detail

• SCOPE_public_profile

  public static final java.lang.String SCOPE_public_profile

  The User Public Profile scope: "public_profile".

  See Also:

  Constant Field Values

• SCOPE_email

  public static final java.lang.String SCOPE_email

  The Email scope: "email".

  See Also:

  Constant Field Values

Constructor Detail

• Facebook

  public Facebook​(OAuthSession session,
                  java.lang.String clientID,
                  java.lang.String clientSecret,
                  java.lang.String... scopes)

  Constructs the service.

  Parameters:

  session - The OAuthSession.

  clientID - The Client ID.

  clientSecret - The Client Secret.

  scopes - The list of scopes as an array, or none for default scopes:

  • SCOPE_public_profile
  • SCOPE_email

  In order to retrieve the user profile information using {@link #getUserProfileInfo()}, you MUST either leave scopes empty or specify the scopes {@link #SCOPE_public_profile}, and if you wish to also get the email address, you must also specify the scope {@link #SCOPE_email}.

  Throws:

  java.lang.NullPointerException - If session, clientID or clientSecret is null.

  java.lang.IllegalArgumentException - If clientID or clientSecret is empty String.

  java.lang.IllegalStateException - If the authentication engine is not initialized.

Method Detail

• initialize

  public static IServiceCreator<Facebook> initialize​(java.lang.String clientID,
                                                     java.lang.String clientSecret,
                                                     java.lang.String... scopes)

  Creates an instance of the ParamInitializedService that holds the parameters for the provider authentication.

  Parameters:

  clientID - The Client ID.

  clientSecret - The Client Secret.

  scopes - The list of scopes as an array, or none for default scopes:

  • SCOPE_public_profile
  • SCOPE_email

  In order to retrieve the user profile information using {@link #getUserProfileInfo()}, you MUST either leave scopes empty or specify the scopes {@link #SCOPE_public_profile}, and if you wish to also get the email address, you must also specify the scope {@link #SCOPE_email}.

  Throws:

  java.lang.NullPointerException - If clientID, clientSecret or any of the scopes values are null is null.

  java.lang.IllegalArgumentException - If clientID, clientSecret or any of the scopes values is empty.

• getAuthenticationProvider

  public AuthenticationProvider getAuthenticationProvider()

  Gets authentication provider.

  Returns:

  The authentication provider enum AuthenticationProvider.Facebook.

• getApproximateSize

  public Size getApproximateSize()

  Gets the approximate size in pixels of the inner browser window requested. This setting used when possible, but is not guaranteed.

  Returns:

  The size, or null if none is known (full screen).

• getLogoutURL

  public java.lang.String getLogoutURL()

  Returns the logout URL for the OAuth service. It is not the same as invalidating an access URL.

  Specified by:

  getLogoutURL in class AbstractOAuthService

  Returns:

  The logout URL is null for none.

• getUserProfileInfo

  public UserProfileInfo getUserProfileInfo()
                                     throws java.io.IOException,
                                            java.lang.InterruptedException,
                                            java.util.concurrent.ExecutionException

  Gets the UserProfileInfo from this service.

  This will cause the user to have to authenticate with the service, unless not already done.

  All fields available for this service that are possible to set and available will be initialized. Other values will be left null, unknown or undefined.

  Specified by:

  getUserProfileInfo in class AbstractOAuthService

  Returns:

  The UserProfileInfo instance.

  Throws:

  java.lang.IllegalStateException - If the authentication has not completed successfully, or if the String "profile" is not among the requested scopes.

  java.util.concurrent.ExecutionException - For execution errors.

  java.lang.InterruptedException - If the revocation action was interrupted.

  java.io.IOException - For I/O errors.