org.bimserver.shared.interfaces

Class OAuthInterfaceAdaptor

java.lang.Object

org.bimserver.shared.interfaces.OAuthInterfaceAdaptor

All Implemented Interfaces:

OAuthInterface, PublicInterface

public class OAuthInterfaceAdaptor
extends Object
implements OAuthInterface

Constructor Summary

Constructors

Constructor and Description
OAuthInterfaceAdaptor()

Method Summary

Modifier and Type	Method and Description
String	authorize(Long oAuthServerOid, SAuthorization authorization)
String	generateForwardUrl(String registrationEndpoint, String authorizeUrl, String returnUrl)
SAuthorization	getAuthorizationById(Long oid)
SOAuthServer	getOAuthServerByClientId(String clientId)
SOAuthServer	getOAuthServerById(Long oid)
String	getRemoteToken(Long soid, String code, Long serverId)
List<SOAuthAuthorizationCode>	listAuthorizationCodes()
List<SOAuthAuthorizationCode>	listIssuedAuthorizationCodes()
List<SOAuthServer>	listRegisteredServers()
List<SOAuthServer>	listRegisteredServersLocal()
Long	registerApplication(String registrationEndpoint, String apiUrl, String redirectUrl) Registers this application (An installed BIMserver) to the given OAuth-enabled Service provider, this step is required for exchanging the clientSecret
SOAuthServer	registerRemoteApplication(String redirectUrl, String name, String description)
void	revokeApplication(Long oid)
void	revokeAuthorization(Long oid)
void	setAuthorizationCode(Long applicationId, String code)

Methods inherited from class java.lang.Object

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

Constructor Detail

OAuthInterfaceAdaptor

public OAuthInterfaceAdaptor()

Method Detail

authorize

public String authorize(Long oAuthServerOid,
                        SAuthorization authorization)
                 throws UserException,
                        ServerException

Specified by:

authorize in interface OAuthInterface

Throws:

UserException

ServerException

generateForwardUrl

public String generateForwardUrl(String registrationEndpoint,
                                 String authorizeUrl,
                                 String returnUrl)
                          throws UserException,
                                 ServerException

Specified by:

generateForwardUrl in interface OAuthInterface

Throws:

UserException

ServerException

getAuthorizationById

public SAuthorization getAuthorizationById(Long oid)
                                    throws UserException,
                                           ServerException

Specified by:

getAuthorizationById in interface OAuthInterface

Throws:

UserException

ServerException

getOAuthServerByClientId

public SOAuthServer getOAuthServerByClientId(String clientId)
                                      throws UserException,
                                             ServerException

Specified by:

getOAuthServerByClientId in interface OAuthInterface

Throws:

UserException

ServerException

getOAuthServerById

public SOAuthServer getOAuthServerById(Long oid)
                                throws UserException,
                                       ServerException

Specified by:

getOAuthServerById in interface OAuthInterface

Throws:

UserException

ServerException

getRemoteToken

public String getRemoteToken(Long soid,
                             String code,
                             Long serverId)
                      throws UserException,
                             ServerException

Specified by:

getRemoteToken in interface OAuthInterface

Throws:

UserException

ServerException

listAuthorizationCodes

public List<SOAuthAuthorizationCode> listAuthorizationCodes()
                                                     throws UserException,
                                                            ServerException

Specified by:

listAuthorizationCodes in interface OAuthInterface

Throws:

UserException

ServerException

listIssuedAuthorizationCodes

public List<SOAuthAuthorizationCode> listIssuedAuthorizationCodes()
                                                           throws UserException,
                                                                  ServerException

Specified by:

listIssuedAuthorizationCodes in interface OAuthInterface

Throws:

UserException

ServerException

listRegisteredServers

public List<SOAuthServer> listRegisteredServers()
                                         throws UserException,
                                                ServerException

Specified by:

listRegisteredServers in interface OAuthInterface

Returns:

Returns a list of OAuthClient objects that contains the information that this BIMserver stores about the connections it has with remote servers

Throws:

UserException

ServerException

listRegisteredServersLocal

public List<SOAuthServer> listRegisteredServersLocal()
                                              throws UserException,
                                                     ServerException

Specified by:

listRegisteredServersLocal in interface OAuthInterface

Throws:

UserException

ServerException

registerApplication

public Long registerApplication(String registrationEndpoint,
                                String apiUrl,
                                String redirectUrl)
                         throws UserException,
                                ServerException

Description copied from interface: OAuthInterface

Registers this application (An installed BIMserver) to the given OAuth-enabled Service provider, this step is required for exchanging the clientSecret

Specified by:

registerApplication in interface OAuthInterface

Throws:

UserException

ServerException - returns the clientId

registerRemoteApplication

public SOAuthServer registerRemoteApplication(String redirectUrl,
                                              String name,
                                              String description)
                                       throws UserException,
                                              ServerException

Specified by:

registerRemoteApplication in interface OAuthInterface

Throws:

UserException

ServerException

revokeApplication

public void revokeApplication(Long oid)
                       throws UserException,
                              ServerException

Specified by:

revokeApplication in interface OAuthInterface

Throws:

UserException

ServerException

revokeAuthorization

public void revokeAuthorization(Long oid)
                         throws UserException,
                                ServerException

Specified by:

revokeAuthorization in interface OAuthInterface

Throws:

UserException

ServerException

setAuthorizationCode

public void setAuthorizationCode(Long applicationId,
                                 String code)
                          throws UserException,
                                 ServerException

Specified by:

setAuthorizationCode in interface OAuthInterface

Throws:

UserException

ServerException