Class BaseEndpoint

java.lang.Object
org.opencastproject.external.endpoint.BaseEndpoint

@Path("/api") @Produces({"application/json","application/v1.0.0+json","application/v1.1.0+json","application/v1.2.0+json","application/v1.3.0+json","application/v1.4.0+json","application/v1.5.0+json","application/v1.6.0+json","application/v1.7.0+json","application/v1.8.0+json","application/v1.9.0+json","application/v1.10.0+json","application/v1.11.0+json"}) public class BaseEndpoint extends Object
The external service endpoint acts as a location for external apis to query the current server of the external supported API.
  • Field Details

    • endpointBaseUrl

      protected String endpointBaseUrl
      Base URL of this endpoint
  • Constructor Details

    • BaseEndpoint

      public BaseEndpoint()
  • Method Details

    • getEndpointInfo

      @GET @Path("") public javax.ws.rs.core.Response getEndpointInfo()
    • getUserInfo

      @GET @Path("info/me") public javax.ws.rs.core.Response getUserInfo()
    • getUserRoles

      @GET @Path("info/me/roles") public javax.ws.rs.core.Response getUserRoles()
    • getOrganizationInfo

      @GET @Path("info/organization") public javax.ws.rs.core.Response getOrganizationInfo()
    • getOrganizationProperties

      @GET @Path("info/organization/properties") public javax.ws.rs.core.Response getOrganizationProperties()
    • getOrganizationPropertiesEngageUiUrl

      @GET @Path("info/organization/properties/engageuiurl") public javax.ws.rs.core.Response getOrganizationPropertiesEngageUiUrl()
    • getVersion

      @GET @Path("version") public javax.ws.rs.core.Response getVersion() throws Exception
      Throws:
      Exception
    • getVersionDefault

      @GET @Path("version/default") public javax.ws.rs.core.Response getVersionDefault() throws Exception
      Throws:
      Exception