net.sourceforge.plantuml.security.authentication.SecurityAuthentication Maven / Gradle / Ivy
Show all versions of plantuml-gplv2 Show documentation
// THIS FILE HAS BEEN GENERATED BY A PREPROCESSOR.
/* +=======================================================================
* |
* | PlantUML : a free UML diagram generator
* |
* +=======================================================================
*
* (C) Copyright 2009-2024, Arnaud Roques
*
* Project Info: https://plantuml.com
*
* If you like this project or if you find it useful, you can support us at:
*
* https://plantuml.com/patreon (only 1$ per month!)
* https://plantuml.com/liberapay (only 1€ per month!)
* https://plantuml.com/paypal
*
*
* PlantUML is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License V2.
*
* THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC
* LICENSE ("AGREEMENT"). [GNU General Public License V2]
*
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
*
* You may obtain a copy of the License at
*
* https://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*
* 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.
*
* PlantUML can occasionally display sponsored or advertising messages. Those
* messages are usually generated on welcome or error images and never on
* functional diagrams.
* See https://plantuml.com/professional if you want to remove them
*
* Images (whatever their format : PNG, SVG, EPS...) generated by running PlantUML
* are owned by the author of their corresponding sources code (that is, their
* textual description in PlantUML language). Those images are not covered by
* this GPL v2 license.
*
* The generated images can then be used without any reference to the GPL v2 license.
* It is not even necessary to stipulate that they have been generated with PlantUML,
* although this will be appreciated by the PlantUML team.
*
* There is an exception : if the textual description in PlantUML language is also covered
* by any license, then the generated images are logically covered
* by the very same license.
*
* This is the IGY distribution (Install GraphViz by Yourself).
* You have to install GraphViz and to setup the GRAPHVIZ_DOT environment variable
* (see https://plantuml.com/graphviz-dot )
*
* Icons provided by OpenIconic : https://useiconic.com/open
* Archimate sprites provided by Archi : http://www.archimatetool.com
* Stdlib AWS provided by https://github.com/milo-minderbinder/AWS-PlantUML
* Stdlib Icons provided https://github.com/tupadr3/plantuml-icon-font-sprites
* ASCIIMathML (c) Peter Jipsen http://www.chapman.edu/~jipsen
* ASCIIMathML (c) David Lippman http://www.pierce.ctc.edu/dlippman
* CafeUndZopfli ported by Eugene Klyuchnikov https://github.com/eustas/CafeUndZopfli
* Brotli (c) by the Brotli Authors https://github.com/google/brotli
* Themes (c) by Brett Schwarz https://github.com/bschwarz/puml-themes
* Twemoji (c) by Twitter at https://twemoji.twitter.com/
*
*/
package net.sourceforge.plantuml.security.authentication;
import java.util.Arrays;
import java.util.Map;
/**
* The authentication to access an endpoint. This information will be generated
* by a SecurityAuthenticationInterceptor.
*
* @author Aljoscha Rittner
*/
public class SecurityAuthentication implements SecurityCredentialsContainer {
// ::remove folder when __HAXE__
/**
* Type of authentication (e.g. basicauth, oauth2)
*/
private final String type;
/**
* Characteristic of an authentication (e.g. openId). Can be null.
*
* This kind of information is typically not needed. Useful for debugging
* purpose.
*/
private final String shape;
/**
* Origin authorization process (e.g. client_credentials.
*
* This kind of information is typically not needed. Useful for debugging
* purpose.
*/
private final String grantType;
/**
* A map of needed data tokens to authenticate access to an endpoint.
*/
private final Map tokens;
public SecurityAuthentication(String type, Map tokens) {
this(type, null, null, tokens);
}
public SecurityAuthentication(String type, String shape, String grantType, Map tokens) {
this.type = type;
this.shape = shape;
this.grantType = grantType;
this.tokens = tokens;
}
public String getType() {
return type;
}
public String getShape() {
return shape;
}
public String getGrantType() {
return grantType;
}
/**
* Requests the state of this authentication.
*
* @return true, if we have no authentication.
*/
public boolean isPublic() {
return "public".equalsIgnoreCase(type) && (tokens == null || tokens.isEmpty());
}
public Map getTokens() {
return tokens;
}
@Override
public void eraseCredentials() {
if (tokens != null && !tokens.isEmpty()) {
for (Object tokenVal : tokens.values()) {
if (tokenVal instanceof char[]) {
Arrays.fill((char[]) tokenVal, '*');
}
}
tokens.clear();
}
}
}