View Javadoc

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  package org.apache.shiro.event;
20  
21  import java.util.EventObject;
22  
23  /**
24   * Root class for all of Shiro's event classes.  Provides access to the timestamp when the event occurred.
25   *
26   * @since 1.3
27   */
28  public abstract class Event extends EventObject {
29  
30      private final long timestamp; //millis since Epoch (UTC time zone).
31  
32      public Event(Object source) {
33          super(source);
34          this.timestamp = System.currentTimeMillis();
35      }
36  
37      /**
38       * Returns the timestamp when this event occurred as the number of milliseconds since Epoch (UTC time zone).
39       *
40       * @return the timestamp when this event occurred as the number of milliseconds since Epoch (UTC time zone).
41       */
42      public long getTimestamp() {
43          return this.timestamp;
44      }
45  }