org.bimserver.shared.interfaces

Interface OAuthInterface

All Superinterfaces:

PublicInterface

All Known Implementing Classes:

OAuthInterfaceAdaptor

public interface OAuthInterface
extends PublicInterface

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)

Method Detail

registerApplication

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

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

Throws:

UserException

ServerException - returns the clientId

listRegisteredServers

List<SOAuthServer> listRegisteredServers()
                                  throws ServerException,
                                         UserException

Returns:

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

Throws:

ServerException

UserException

listRegisteredServersLocal

List<SOAuthServer> listRegisteredServersLocal()
                                       throws ServerException,
                                              UserException

Throws:

ServerException

UserException

generateForwardUrl

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

Throws:

ServerException

UserException

setAuthorizationCode

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

Throws:

UserException

ServerException

getOAuthServerById

SOAuthServer getOAuthServerById(Long oid)
                         throws ServerException,
                                UserException

Throws:

ServerException

UserException

getOAuthServerByClientId

SOAuthServer getOAuthServerByClientId(String clientId)
                               throws ServerException,
                                      UserException

Throws:

ServerException

UserException

listAuthorizationCodes

List<SOAuthAuthorizationCode> listAuthorizationCodes()
                                              throws ServerException,
                                                     UserException

Throws:

ServerException

UserException

authorize

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

Throws:

ServerException

UserException

revokeApplication

void revokeApplication(Long oid)
                throws ServerException,
                       UserException

Throws:

ServerException

UserException

listIssuedAuthorizationCodes

List<SOAuthAuthorizationCode> listIssuedAuthorizationCodes()
                                                    throws ServerException,
                                                           UserException

Throws:

ServerException

UserException

getAuthorizationById

SAuthorization getAuthorizationById(Long oid)
                             throws ServerException,
                                    UserException

Throws:

ServerException

UserException

revokeAuthorization

void revokeAuthorization(Long oid)
                  throws ServerException,
                         UserException

Throws:

ServerException

UserException

getRemoteToken

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

Throws:

ServerException

UserException

registerRemoteApplication

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

Throws:

UserException

ServerException