001: package org.tigris.scarab.util;
002:
003: /* ================================================================
004: * Copyright (c) 2000-2002 CollabNet. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions are
008: * met:
009: *
010: * 1. Redistributions of source code must retain the above copyright
011: * notice, this list of conditions and the following disclaimer.
012: *
013: * 2. Redistributions in binary form must reproduce the above copyright
014: * notice, this list of conditions and the following disclaimer in the
015: * documentation and/or other materials provided with the distribution.
016: *
017: * 3. The end-user documentation included with the redistribution, if
018: * any, must include the following acknowlegement: "This product includes
019: * software developed by Collab.Net <http://www.Collab.Net/>."
020: * Alternately, this acknowlegement may appear in the software itself, if
021: * and wherever such third-party acknowlegements normally appear.
022: *
023: * 4. The hosted project names must not be used to endorse or promote
024: * products derived from this software without prior written
025: * permission. For written permission, please contact info@collab.net.
026: *
027: * 5. Products derived from this software may not use the "Tigris" or
028: * "Scarab" names nor may "Tigris" or "Scarab" appear in their names without
029: * prior written permission of Collab.Net.
030: *
031: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
032: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
033: * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
034: * IN NO EVENT SHALL COLLAB.NET OR ITS CONTRIBUTORS BE LIABLE FOR ANY
035: * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
036: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
037: * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
038: * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
039: * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
040: * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
041: * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
042: *
043: * ====================================================================
044: *
045: * This software consists of voluntary contributions made by many
046: * individuals on behalf of Collab.Net.
047: */
048:
049: import org.apache.fulcrum.security.util.TurbineSecurityException;
050: import org.tigris.scarab.tools.ScarabLocalizationTool;
051: import org.tigris.scarab.tools.localization.Localizable;
052:
053: /**
054: * A TurbineSecurityException ready for internationalization [in the Scarab L10N framework].
055: *
056: * @version $Id: ScarabLocalizedTurbineSecurityException.java 9088 2004-05-01 19:10:51Z dabbous $
057: * @author <a href="mailto:dabbous@saxess.com">Hussayn Dabbous</a>
058: */
059: public class ScarabLocalizedTurbineSecurityException extends
060: TurbineSecurityException implements Localizable {
061: private final Throwable throwable;
062:
063: // may be null
064: private ScarabLocalizationTool localizer;
065:
066: /**
067: * Constructs a TurbineSecurityException wrapper for a given exception.
068: * The wrapper is simply a container with no special
069: * functionality.
070: * @param e
071: */
072: public ScarabLocalizedTurbineSecurityException(final Throwable t) {
073: super ("");
074: throwable = t;
075: localizer = null;
076: }
077:
078: /**
079: * Set the localizer to be used in later calls to {@link #getLocalizedMessage()}
080: * @param theLocalizer the localizer (may be <code>null</code>)
081: */
082: public void setLocalizer(final ScarabLocalizationTool theLocalizer) {
083: localizer = theLocalizer;
084: }
085:
086: /**
087: * Delegator for the wrapped exceptions getMessage() method.
088: * @return the wrapped exception's message
089: */
090: public String getMessage() {
091: return throwable.getMessage();
092: }
093:
094: /**
095: * Localize this exception using the wrapped exception.
096: * return the localized message, else return the message string
097: * of the wrapped exception.
098: * @param l10n
099: * @return
100: */
101: public String getMessage(final ScarabLocalizationTool l10n) {
102: return l10n.getMessage(throwable);
103: }
104:
105: /**
106: * Return the localized message for that throwable, if a localizer
107: * was defined using {@link #setLocalizer(ScarabLocalizationTool)}
108: * @return the localized message.
109: */
110: public String getLocalizedMessage() {
111: if (localizer != null) {
112: return getMessage(localizer);
113: } else {
114: return super.getLocalizedMessage();
115: }
116: }
117:
118: }
|