IdentityZoned.java

/*
 * Copyright 2013-2017 the original author or authors.
 *
 * 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 org.cloudfoundry.uaa;

import com.fasterxml.jackson.annotation.JsonIgnore;
import org.cloudfoundry.Nullable;

/**
 * An interface that indicates that a UAA request can specify an identity zone in its header
 */
public interface IdentityZoned {

    /**
     * Returns the identity zone id
     *
     * @return the identity zone id
     */
    @JsonIgnore
    @Nullable
    String getIdentityZoneId();

}