View Javadoc
1 package org.apache.turbine.services.uniqueid; 2 3 /* ==================================================================== 4 * The Apache Software License, Version 1.1 5 * 6 * Copyright (c) 2001 The Apache Software Foundation. All rights 7 * reserved. 8 * 9 * Redistribution and use in source and binary forms, with or without 10 * modification, are permitted provided that the following conditions 11 * are met: 12 * 13 * 1. Redistributions of source code must retain the above copyright 14 * notice, this list of conditions and the following disclaimer. 15 * 16 * 2. Redistributions in binary form must reproduce the above copyright 17 * notice, this list of conditions and the following disclaimer in 18 * the documentation and/or other materials provided with the 19 * distribution. 20 * 21 * 3. The end-user documentation included with the redistribution, 22 * if any, must include the following acknowledgment: 23 * "This product includes software developed by the 24 * Apache Software Foundation (http://www.apache.org/)." 25 * Alternately, this acknowledgment may appear in the software itself, 26 * if and wherever such third-party acknowledgments normally appear. 27 * 28 * 4. The names "Apache" and "Apache Software Foundation" and 29 * "Apache Turbine" must not be used to endorse or promote products 30 * derived from this software without prior written permission. For 31 * written permission, please contact apache@apache.org. 32 * 33 * 5. Products derived from this software may not be called "Apache", 34 * "Apache Turbine", nor may "Apache" appear in their name, without 35 * prior written permission of the Apache Software Foundation. 36 * 37 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED 38 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 39 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 40 * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR 41 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 42 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 43 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF 44 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND 45 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 46 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT 47 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 48 * SUCH DAMAGE. 49 * ==================================================================== 50 * 51 * This software consists of voluntary contributions made by many 52 * individuals on behalf of the Apache Software Foundation. For more 53 * information on the Apache Software Foundation, please see 54 * <http://www.apache.org/>;. 55 */ 56 57 // Turbine stuff. 58 import org.apache.turbine.services.Service; 59 60 /*** 61 * <p> This service provides unique identifiers for the instance of 62 * Turbine, and for objects it creates. 63 * 64 * @author <a href="mailto:Rafal.Krzewski@e-point.pl">Rafal Krzewski</a> 65 * @version $Id: UniqueIdService.java,v 1.1.1.1 2001/08/16 05:09:23 jvanzyl Exp $ 66 */ 67 public interface UniqueIdService 68 extends Service 69 { 70 public static final String SERVICE_NAME = "UniqueIdService"; 71 72 /*** 73 * <p> Returs an identifer of this Turbine instance that is unique 74 * both on the server and worldwide. 75 * 76 * @return A String with the instance identifier. 77 */ 78 public String getInstanceId(); 79 80 /*** 81 * <p> Returns an identifier that is unique within this turbine 82 * instance, but does not have random-like apearance. 83 * 84 * <p> This method is intended to work fast; it can be used for 85 * creating names of temporary files. 86 * 87 * @return A String with the non-random looking instance 88 * identifier. 89 * */ 90 public String getUniqueId(); 91 92 /*** 93 * <p> Returns a unique identifier that looks like random data. 94 * 95 * <p> This method provides indentifiers in a way that makes it 96 * hard to guess or count, but still ensures their uniqueness 97 * within this instance of Turbine. It can be used for generating 98 * cookies or other data that travels back and forth between 99 * server and browser, and is potentialy security sensitive. 100 * 101 * @return A String with the random looking instance identifier. 102 */ 103 public String getPseudorandomId(); 104 }

This page was automatically generated by Maven