com.nimbusds.openid.connect.sdk.assurance.evidences.UtilityBillEvidence Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of oauth2-oidc-sdk Show documentation
Show all versions of oauth2-oidc-sdk Show documentation
OAuth 2.0 SDK with OpenID Connection extensions for developing
client and server applications.
/*
* 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.assurance.evidences;
import net.jcip.annotations.Immutable;
import net.minidev.json.JSONObject;
import com.nimbusds.oauth2.sdk.ParseException;
import com.nimbusds.oauth2.sdk.util.JSONObjectUtils;
import com.nimbusds.oauth2.sdk.util.date.SimpleDate;
import com.nimbusds.openid.connect.sdk.claims.Address;
/**
* Utility bill used as identity evidence.
*
* Related specifications:
*
*
* - OpenID Connect for Identity Assurance 1.0, section 4.1.1.
*
*/
@Immutable
public final class UtilityBillEvidence extends IdentityEvidence {
/**
* The utility provider name.
*/
private final String providerName;
/**
* The utility provider address details.
*/
private final Address providerAddress;
/**
* The utility bill date.
*/
private final SimpleDate date;
/**
* Creates a new utility bill used as identity evidence.
*
* @param providerName The utility provider name. Must not be
* {@code null}.
* @param providerAddress The utility provider address details. Must
* not be {@code null}.
* @param date The utility bill date. Must not be
* {@code null}.
*/
public UtilityBillEvidence(final String providerName, final Address providerAddress, final SimpleDate date) {
super(IdentityEvidenceType.UTILITY_BILL);
if (providerName == null) {
throw new IllegalArgumentException("The utility provider name must not be null");
}
this.providerName = providerName;
if (providerAddress == null) {
throw new IllegalArgumentException("The utility provider address must not be null");
}
this.providerAddress = providerAddress;
if (date == null) {
throw new IllegalArgumentException("The utility bill date must not be null");
}
this.date = date;
}
/**
* The utility provider name.
*
* @return The utility provider name.
*/
public String getUtilityProviderName() {
return providerName;
}
/**
* Returns the utility provider address details.
*
* @return The utility provider address details.
*/
public Address getUtilityProviderAddress() {
return providerAddress;
}
/**
* Returns the utility bill date.
*
* @return The utility bill date.
*/
public SimpleDate getUtilityBillDate() {
return date;
}
@Override
public JSONObject toJSONObject() {
JSONObject o = super.toJSONObject();
JSONObject providerDetails = new JSONObject();
providerDetails.put("name", getUtilityProviderName());
providerDetails.putAll(getUtilityProviderAddress().toJSONObject());
o.put("provider", providerDetails);
o.put("date", getUtilityBillDate().toISO8601String());
return o;
}
/**
* Parses a utility bill evidence from the specified JSON object.
*
* @param jsonObject The JSON object. Must not be {@code null}.
*
* @return The utility bill evidence.
*
* @throws ParseException If parsing failed.
*/
public static UtilityBillEvidence parse(final JSONObject jsonObject)
throws ParseException {
ensureType(IdentityEvidenceType.UTILITY_BILL, jsonObject);
JSONObject providerDetails = JSONObjectUtils.getJSONObject(jsonObject, "provider");
String providerName = JSONObjectUtils.getString(providerDetails, "name");
providerDetails.remove("name");
Address providerAddress = Address.parse(providerDetails.toJSONString());
SimpleDate date = SimpleDate.parseISO8601String(JSONObjectUtils.getString(jsonObject, "date"));
return new UtilityBillEvidence(providerName, providerAddress, date);
}
}