com.nimbusds.openid.connect.sdk.id.SectorID Maven / Gradle / Ivy
Show all versions of oauth2-oidc-sdk Show documentation
/*
* oauth2-oidc-sdk
*
* Copyright 2012-2016, Connect2id Ltd and contributors.
*
* 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.nimbusds.openid.connect.sdk.id;
import java.net.URI;
import net.jcip.annotations.Immutable;
import com.nimbusds.oauth2.sdk.id.Audience;
import com.nimbusds.oauth2.sdk.id.Identifier;
/**
* Sector identifier.
*
* Related specifications:
*
*
* - OpenID Connect Core 1.0, section 8.1.
*
*/
@Immutable
public final class SectorID extends Identifier {
private static final long serialVersionUID = -3769967342420085584L;
/**
* Ensures the URI has a {@code https} scheme.
*
* @param sectorURI The URI. Must have a {@code https} scheme and not
* be {@code null}.
*/
public static void ensureHTTPScheme(final URI sectorURI) {
if (! "https".equalsIgnoreCase(sectorURI.getScheme())) {
throw new IllegalArgumentException("The URI must have a https scheme");
}
}
/**
* Ensures the URI contains a host component.
*
* @param sectorURI The URI. Must contain a host component and not be
* {@code null}.
*
* @return The host component.
*/
public static String ensureHostComponent(final URI sectorURI) {
String host = sectorURI.getHost();
if (host == null) {
throw new IllegalArgumentException("The URI must contain a host component");
}
return host;
}
/**
* Creates a new sector identifier based on a internet host.
*
* Example host: client.example.com
*
* @param host The host. The value is not validated. Must not be empty
* or {@code null}.
*/
public SectorID(final String host) {
super(host);
}
/**
* Creates a new sector identifier based on the host component of an
* URI.
*
*
Example URI: https://client.example.com
*
* @param uri The URI. Must contain a host component and must not be
* {@code null}.
*/
public SectorID(final URI uri) {
super(ensureHostComponent(uri));
}
/**
* Creates a new sector identifier based on an audience.
*
* @param audience The audience. Must not be empty or {@code null}.
*/
public SectorID(final Audience audience) {
super(audience.getValue());
}
/**
* Creates a new sector identifier based on a generic identifier.
*
* @param identifier The identifier. Must not be empty or {@code null}.
*/
public SectorID(final Identifier identifier) {
super(identifier.getValue());
}
}