Main Content

login

Log in to OSLC client

    Description

    example

    login(myClient) prompts for login credentials and authenticates myClient with the Open Services for Lifecycle Collaboration (OSLC) server.

    Note

    If the login function does not work for your service provider, try using setHttpOptions and setHttpHeader to authenticate an instance of oslc.Client with your OSLC service provider. The login function might not work with some OSLC service providers.

    Examples

    collapse all

    This example shows how to create an OSLC client in MATLAB® and configure the client to connect to an OSLC service provider for the requirements management domain.

    Create the OSLC client.

    myClient = oslc.Client;

    Set the user and server URL for your service provider. Then set the service root and catalog path for the requirements management domain and the configuration query path.

    setUser(myClient,'jdoe');
    setServer(myClient,'https://localhost:9443');
    setServiceRoot(myClient,'rm');
    setCatalogPath(myClient,'/oslc_rm/catalog');
    setConfigurationQueryPath(myClient,'gc/oslc-query/configurations');
    myClient

    Log in to the client and enter your credentials when prompted.

    login(myClient);

    Get the available service providers in the specified catalog path and service root. Set the OSLC client to the desired service provider.

    providers = getServiceProviderNames(myClient)
    providers =
    
      4×1 cell array
    
        {'OSLC Plugin'                                  }
        {'Model Based Design with OSLC'                 }
        {'OSLC4RM'                                      }
        {'Interactive Testing (Requirements Management)'}

    setServiceProvider(myClient,'OSLC Plugin');

    If applicable, get the available configuration contexts. Set the OSLC client to the desired configuration context.

    configurations = getConfigurationContextNames(myClient)
    configurations =
    
      2×1 cell array
    
        {'Initial Development'}
        {'Initial Baseline'   }

    setConfigurationContext(myClient,'Initial Development');

    Inspect the client properties.

    myClient
    myClient = 
    
      Client with properties:
    
             ServiceProvider: 'OSLC Plugin'
        ConfigurationContext: 'Initial Development'
                  CatalogUrl: 'https://localhost:9443/rm/oslc_rm/catalog'

    Input Arguments

    collapse all

    OSLC client, specified as an oslc.Client object.

    Introduced in R2021a