com.sun.xml.wss.provider.wsit.EntryInfo Maven / Gradle / Ivy
/*
* Copyright (c) 1997, 2022 Oracle and/or its affiliates. All rights reserved.
*
* This program and the accompanying materials are made available under the
* terms of the Eclipse Distribution License v. 1.0, which is available at
* http://www.eclipse.org/org/documents/edl-v10.php.
*
* SPDX-License-Identifier: BSD-3-Clause
*/
package com.sun.xml.wss.provider.wsit;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import jakarta.security.auth.message.config.AuthConfigFactory.RegistrationContext;
/*
* Each entry is either a constructor entry or a registration entry.
* Use nulls rather than empty Strings or Lists for fields that
* have no value.
*
* This class will not be used outside of its package.
*
* @author Bobby Bissett
*/
final class EntryInfo {
private final String className;
private final Map properties;
private List regContexts;
/*
* This will create a constructor entry. The className
* must not be null.
*/
EntryInfo(String className, Map properties) {
if (className == null) {
throw new IllegalArgumentException(
"Class name for registration entry cannot be null");
}
this.className = className;
this.properties = properties;
}
/*
* This will create a registration entry. The list of
* registration contexts must not be null or empty. Each registration
* context will contain at least a non-null layer or appContextId.
*/
EntryInfo(String className, Map properties,
List ctxs) {
if (ctxs == null || ctxs.isEmpty()) {
throw new IllegalArgumentException(
"Registration entry must contain one or" +
"more registration contexts");
}
this.className = className;
this.properties = properties;
this.regContexts = ctxs;
}
/*
* A helper method for creating a registration entry with
* one registration context. If the context is null, this
* entry is a constructor entry.
*/
EntryInfo(String className, Map properties,
RegistrationContext ctx) {
this.className = className;
this.properties = properties;
if (ctx != null) {
RegistrationContext ctxImpl =
new RegistrationContextImpl(ctx.getMessageLayer(),
ctx.getAppContext(), ctx.getDescription(), ctx.isPersistent());
List newList =
new ArrayList<>(1);
newList.add(ctxImpl);
this.regContexts = newList;
}
}
boolean isConstructorEntry() {
return (regContexts == null);
}
String getClassName() {
return className;
}
Map getProperties() {
return properties;
}
List getRegContexts() {
return regContexts;
}
/*
* Compares an entry info to this one. They are
* considered equal if:
* - they are both constructor or are both registration entries
* - the classnames are equal or are both null
* - the property maps are equal or are both null
*
* If the entry is a registration entry, registration
* contexts are not considered for our purposes. For
* instance, we may want to get a certain registration
* entry in order to add a registration context to it.
*
* @see com.sun.enterprise.security.jmac.config.RegStoreFileParser
*/
boolean equals(EntryInfo target) {
if (target == null) {
return false;
}
return ( !(isConstructorEntry() ^ target.isConstructorEntry()) &&
matchStrings(className, target.getClassName()) &&
matchMaps(properties, target.getProperties()) );
}
/*
* Utility method for comparing strings such that
* two null strings are considered "equal."
*/
static boolean matchStrings(String s1, String s2) {
if (s1 == null && s2 == null) {
return true;
}
if (s1 == null || s2 == null) {
return false;
}
return s1.equals(s2);
}
/*
* Utility method for comparing maps such that
* two null maps are considered "equal."
*/
static boolean matchMaps(Map m1, Map m2) {
if (m1 == null && m2 == null) {
return true;
}
if (m1 == null || m2 == null) {
return false;
}
return m1.equals(m2);
}
}