leap.oauth2.server.userinfo.AuthzAddress Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of leap-oauth2-server Show documentation

There is a newer version: 0.7.13b

/*
 *
 *  * Copyright 2013 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 leap.oauth2.server.userinfo;

import java.util.Map;

/**
 * 
 * Address Claim
 * 
 * @see OpenId Connect
 * 
 * @author kael.
 */
public interface AuthzAddress {
    
    String FORMATTED      = "formatted";
    String STREET_ADDRESS = "street_address";
    String LOCALITY       = "locality";
    String REGION         = "region";
    String POSTAL_CODE    = "postal_code";
    String COUNTRY        = "country";
    
    /**
     * Returns formatted or null
     */
    String getFormatted();

    /**
     * Returns street_address or null
     */
    String getStreetAddress();

    /**
     * Returns locality or null
     */
    String getLocality();
    /**
     * Returns region or null
     */
    String getRegion();
    /**
     * Returns postal_code or null
     */
    String getPostalCode();
    /**
     * Returns country or null
     */
    String getCountry();

    /**
     * convert this object to a map
     */
    Map toMap();

    /**
     * Returns an unmodifiable extend properties map
     */
    Map getExtProperties();

    /**
     * put an extend property
     */
    void putExtProperty(String name, Object value);
    
}