Package com.sodius.oslc.app.jazz.requests

Class GetGlobalConfigurationFriend

java.lang.Object
com.sodius.oslc.app.jazz.requests.GetGlobalConfigurationFriend
All Implemented Interfaces:
ResourceRequest<Optional<Friend>>, Callable<Optional<Friend>>
public class GetGlobalConfigurationFriend extends Object implements ResourceRequest<Optional<Friend>>
Retrieves information on the Jazz Global Configuration application registered as a friend of a specific OSLC application.
Since:
1.3.0
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    GetGlobalConfigurationFriend.Result
    References discovered global configuration friends and friend applications that cannot be reached.

  • Constructor Summary

    Constructors
    Constructor
    Description
    GetGlobalConfigurationFriend(FriendProvider friendProvider)
    Creates a request to read information on the Jazz Global Configuration application registered as a friend in the specified provider.
    GetGlobalConfigurationFriend(OslcClient client, URI rootServicesLocation)
    Creates a request to read information on the Jazz Global Configuration application registered as a friend of the specified OSLC application.

  • Method Summary

    Modifier and Type
    Method
    Description
    Optional<Friend>
    call()
    Returns the Jazz Global Configuration application registered as a friend of a specific OSLC application, if any.
    GetGlobalConfigurationFriend.Result
    getAll()
    Returns a Result instance that gives access to all Jazz Global Configuration applications registered as friends, as well as friend applications that couldn't be reached.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • GetGlobalConfigurationFriend

      public GetGlobalConfigurationFriend(OslcClient client, URI rootServicesLocation)
      Creates a request to read information on the Jazz Global Configuration application registered as a friend of the specified OSLC application.
      Parameters:
      client - the OSLC client to connect to the application.
      rootServicesLocation - the URI of an OSLC application root services (e.g. https://myserver:9443/rm/rootservices) which has friends.

    • GetGlobalConfigurationFriend

      public GetGlobalConfigurationFriend(FriendProvider friendProvider)
      Creates a request to read information on the Jazz Global Configuration application registered as a friend in the specified provider.
      Parameters:
      friendProvider - a provider of friends.
      Since:
      1.4.0

  • Method Details

    • call

      public Optional<Friend> call()
      Returns the Jazz Global Configuration application registered as a friend of a specific OSLC application, if any. This method returns Optional.empty() if the OSLC application has no registered friend for Jazz Global Configuration or if the user has no access to this friend information.
      Specified by:
      call in interface Callable<Optional<Friend>>
      Specified by:
      call in interface ResourceRequest<Optional<Friend>>

    • getAll

      public GetGlobalConfigurationFriend.Result getAll()
      Returns a Result instance that gives access to all Jazz Global Configuration applications registered as friends, as well as friend applications that couldn't be reached.
      Returns:
      a Result instance.
      Since:
      2.0.0