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.common.cache;
21
22 import java.io.Closeable;
23 import java.time.Instant;
24
25 /**
26 * A cache to store (String) identifiers to avoid replay attacks. An example of such an identifier
27 * is a UsernameToken nonce.
28 */
29 public interface ReplayCache extends Closeable {
30
31 /**
32 * Add the given identifier to the cache. It will be cached for a default amount of time.
33 * @param identifier The identifier to be added
34 */
35 void add(String identifier);
36
37 /**
38 * Add the given identifier to the cache to be cached for the given time
39 * @param identifier The identifier to be added
40 * @param expiry A custom expiry time for the identifier
41 */
42 void add(String identifier, Instant expiry);
43
44 /**
45 * Return true if the given identifier is contained in the cache
46 * @param identifier The identifier to check
47 */
48 boolean contains(String identifier);
49
50 }