Class RootServices

  • All Implemented Interfaces:
    org.eclipse.lyo.oslc4j.core.model.IExtendedResource, org.eclipse.lyo.oslc4j.core.model.IResource
    Direct Known Subclasses:
    LqeRootServices

    @OslcNamespace("http://open-services.net/ns/core#")
    @OslcResourceShape(describes="http://open-services.net/ns/core#RootServices")
    public class RootServices
    extends org.eclipse.lyo.oslc4j.core.model.AbstractResource

    Represents a RootServices resource.

    This resource cannot be de-serialized directly by a Jena provider, as the root services resource does not have an rdf:type. It can be parsed using com.sodius.oslc.client.requests.GetRootServices. It has an OslcResourceShape annotation just so that it can be correctly parsed within GetRootServices.

    Due to the very flexible and extensible nature of root services, all root services properties are stored as extended properties.

    • Constructor Detail

      • RootServices

        public RootServices()
    • Method Detail

      • getTitle

        public String getTitle()
        Returns the RootServices title.
        Returns:
        the RootServices title
        Since:
        1.14.0
      • setTitle

        public void setTitle​(String title)
        Sets the RootServices title.
        Parameters:
        title - the RootServices title.
        Since:
        1.14.0
      • getOAuthAccessToken

        public URI getOAuthAccessToken()
        Returns the OAuth Access Token URL.
        Returns:
        the OAuth Access Token URL
        Since:
        1.14.0
      • setOAuthAccessToken

        public void setOAuthAccessToken​(URI oauthAccessTokenUrl)
        Sets the OAuth Access Token URL.
        Parameters:
        oauthAccessTokenUrl - the OAuth Access Token URL.
        Since:
        1.14.0
      • getOAuthApprovalModule

        public URI getOAuthApprovalModule()
        Returns the URL of an HTML page where a provisional consumer can be approved.
        Returns:
        the URL of an HTML page where a provisional consumer can be approved.
        Since:
        1.9.0
      • setOAuthApprovalModule

        public void setOAuthApprovalModule​(URI oauthApprovalModuleUrl)
        Sets the URL of an HTML page where a provisional consumer can be approved.
        Parameters:
        oauthApprovalModuleUrl - the URL of an HTML page where a provisional consumer can be approved.
        Since:
        1.14.0
      • getOAuthRequestConsumerKey

        public URI getOAuthRequestConsumerKey()
        Returns the URL to request creating a provisional consumer key.
        Returns:
        the URL to request creating a provisional consumer key.
        Since:
        1.9.0
      • setOAuthRequestConsumerKey

        public void setOAuthRequestConsumerKey​(URI oauthRequestConsumerKeyUrl)
        Sets the URL to request creating a provisional consumer key.
        Parameters:
        oauthRequestConsumerKeyUrl - the URL to request creating a provisional consumer key.
        Since:
        1.14.0
      • getOAuthRequestToken

        public URI getOAuthRequestToken()
        Returns the OAuth Request Token URL.
        Returns:
        the OAuth Request Token URL
        Since:
        1.14.0
      • setOAuthRequestToken

        public void setOAuthRequestToken​(URI oauthRequestTokenUrl)
        Sets the OAuth Request Token URL.
        Parameters:
        oauthRequestTokenUrl - the OAuth Request Token URL.
        Since:
        1.14.0
      • getOAuthUserAuthorization

        public URI getOAuthUserAuthorization()
        Returns the OAuth User Authorization URL
        Returns:
        the OAuth User Authorization URL
        Since:
        1.14.0
      • setOAuthUserAuthorization

        public void setOAuthUserAuthorization​(URI oauthUserAuthorizationUrl)
        Sets the OAuth User Authorization URL
        Parameters:
        oauthUserAuthorizationUrl - the OAuth User Authorization URL
        Since:
        1.14.0
      • getOAuthDomain

        public String getOAuthDomain()
        Returns the OAuth domain.
        Returns:
        the OAuth domain.
        Since:
        1.9.0
      • setOAuthDomain

        public void setOAuthDomain​(String oauthDomain)
        Sets the OAuth domain.
        Parameters:
        oauthDomain - the OAuth domain.
        Since:
        1.14.0
      • getOAuthRealmName

        public String getOAuthRealmName()
        Returns the OAuth Realm Name.
        Returns:
        the OAuth Realm Name
        Since:
        1.14.0
      • setOAuthRealmName

        public void setOAuthRealmName​(String oauthRealmName)
        Sets the OAuth Realm Name.
        Parameters:
        oauthRealmName - the OAuth Realm Name.
        Since:
        1.14.0
      • getCmCatalog

        public URI getCmCatalog()
        Returns the URI of the service provider catalog for the OSLC CM domain.
        Returns:
        the URI of the service provider catalog for the OSLC CM domain.
        Since:
        1.4.0
      • setCmCatalog

        public void setCmCatalog​(URI cmServiceProviders)
        Sets the URI of the service provider catalog for the OSLC CM domain.
        Parameters:
        cmServiceProviders - the URI of the service provider catalog for the OSLC CM domain.
        Since:
        1.14.0
      • getRmCatalog

        public URI getRmCatalog()
        Returns the URI of the service provider catalog for the OSLC RM domain.
        Returns:
        the URI of the service provider catalog for the OSLC RM domain.
        Since:
        1.4.0
      • setRmCatalog

        public void setRmCatalog​(URI rmServiceProviders)
        Sets the URI of the service provider catalog for the OSLC RM domain.
        Parameters:
        rmServiceProviders - the URI of the service provider catalog for the OSLC RM domain.
        Since:
        1.14.0
      • getAmCatalog

        public URI getAmCatalog()
        Returns the URI of the service provider catalog for the OSLC AM domain.
        Returns:
        the URI of the service provider catalog for the OSLC AM domain.
        Since:
        1.4.0
      • setAmCatalog

        public void setAmCatalog​(URI amServiceProviders)
        Sets the URI of the service provider catalog for the OSLC AM domain.
        Parameters:
        amServiceProviders - the URI of the service provider catalog for the OSLC AM domain.
        Since:
        1.14.0
      • getConfigCatalog

        public URI getConfigCatalog()
        Returns the URI of the service provider catalog for the OSLC Config domain.
        Returns:
        the URI of the service provider catalog for the OSLC Config domain.
        Since:
        1.4.0
      • setConfigCatalog

        public void setConfigCatalog​(URI configServiceProviders)
        Sets the URI of the service provider catalog for the OSLC Config domain.
        Parameters:
        configServiceProviders - the URI of the service provider catalog for the OSLC Config domain.
        Since:
        1.14.0
      • getQmCatalog

        public URI getQmCatalog()
        Returns the URI of the service provider catalog for the OSLC QM domain.
        Returns:
        the URI of the service provider catalog for the OSLC QM domain.
        Since:
        1.5.0
      • setQmCatalog

        public void setQmCatalog​(URI qmServiceProviders)
        Sets the URI of the service provider catalog for the OSLC QM domain.
        Parameters:
        qmServiceProviders - the URI of the service provider catalog for the OSLC QM domain.
        Since:
        1.14.0
      • getPublisher

        public URI getPublisher()
        Returns:
        the URI of the application publisher.
        Since:
        1.1.0
      • setPublisher

        public void setPublisher​(URI publisher)
        Sets the URI of the application publisher.
        Parameters:
        publisher - the URI of the application publisher.
        Since:
        1.14.0
      • getCurrentUser

        public URI getCurrentUser()
        Returns:
        the URI of the current user.
        Since:
        3.1.0
      • setCurrentUser

        public void setCurrentUser​(URI currentUser)
        Sets the URI of the current user.
        Parameters:
        currentUser - the URI of current user.
        Since:
        3.1.0
      • addTrackedResourceSet

        public void addTrackedResourceSet​(URI about,
                                          URI dctermsType,
                                          String title,
                                          String description,
                                          URI... domains)
        Allows to add a TrackedResourceSet in RootServices' extended properties
        Parameters:
        title - of the trs, e.g. OSLC Connect for Jira CM Resources (TRS 2.0)
        about - of the trs, e.g. https://host:8445/jira/rest/oslc/1.0/cm/trs
        dctermsType - TrackedResourceSet's type, referenced by an URI, e.g. http://open-services.net/ns/cm#
        description - of the trs, e.g. Contains information about changes to issues.
        domains - TrackedResourceSet's domains, referenced by URIs, e.g. http://open-services.net/ns/cm#
        Since:
        1.14.0