1 /**
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 */
19
20 package org.apache.wss4j.dom.validate;
21
22
23 import org.apache.wss4j.common.ext.WSSecurityException;
24 import org.apache.wss4j.dom.handler.RequestData;
25
26 /**
27 * This interface describes a pluggable way of validating credentials that have been extracted
28 * by the processors.
29 */
30 public interface Validator {
31
32 /**
33 * Validate the credential argument. This method returns a Credential instance that
34 * represents the validated credential. This instance can be the same as the instance
35 * that was validated, or it can represent some transformation of the initial Credential
36 * instance.
37 * @param credential the Credential to be validated
38 * @param data the RequestData associated with the request
39 * @return a validated Credential
40 * @throws WSSecurityException on a failed validation
41 */
42 Credential validate(Credential credential, RequestData data) throws WSSecurityException;
43
44
45 }