com.stormpath.sdk.saml.SamlServiceProviderRegistrationOptions Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stormpath-sdk-api Show documentation

The Stormpath Java SDK API .jar provides a Java API that your code can use to make calls to the Stormpath API. This .jar is the only compile-time dependency within the Stormpath SDK project that your code should depend on. Implementations of this API (implementation .jars) should be runtime dependencies only.

The newest version!

/*
 * Copyright 2016 Stormpath, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.stormpath.sdk.saml;

import com.stormpath.sdk.query.Options;

/**
 * SamlServiceProviderRegistration-specific options that may be specified when retrieving {@link SamlServiceProviderRegistration} resources.
 *
 * @since 1.3.0
 */
public interface SamlServiceProviderRegistrationOptions extends Options {

    /**
     * Ensures that when retrieving a SamlIdentityProvider, the SamlServiceProviderRegistration's assigned {@link SamlServiceProviderRegistration#getServiceProvider()}
     * are also retrieved in the same request.  This enhances performance by leveraging a single request
     * to retrieve multiple related resources you know you will use.
     *
     * @return this instance for method chaining.
     */
    T withServiceProvider();

    /**
     * Ensures that when retrieving a SamlIdentityProvider, the SamlServiceProviderRegistration's assigned {@link SamlServiceProviderRegistration#getIdentityProvider()}
     * are also retrieved in the same request.  This enhances performance by leveraging a single request
     * to retrieve multiple related resources you know you will use.
     *
     * @return this instance for method chaining.
     */
    T withIdentityProvider();
}