/* * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER. * * Copyright (c) 1997-2011 Oracle and/or its affiliates. All rights reserved. * * The contents of this file are subject to the terms of either the GNU * General Public License Version 2 only ("GPL") or the Common Development * and Distribution License("CDDL") (collectively, the "License"). You * may not use this file except in compliance with the License. You can * obtain a copy of the License at * https://glassfish.dev.java.net/public/CDDL+GPL_1_1.html * or packager/legal/LICENSE.txt. See the License for the specific * language governing permissions and limitations under the License. * * When distributing the software, include this License Header Notice in each * file and include the License file at packager/legal/LICENSE.txt. * * GPL Classpath Exception: * Oracle designates this particular file as subject to the "Classpath" * exception as provided by Oracle in the GPL Version 2 section of the License * file that accompanied this code. * * Modifications: * If applicable, add the following below the License Header, with the fields * enclosed by brackets [] replaced by your own identifying information: * "Portions Copyright [year] [name of copyright owner]" * * Contributor(s): * If you wish your version of this file to be governed by only the CDDL or * only the GPL Version 2, indicate your decision by adding "[Contributor] * elects to include this software in this distribution under the [CDDL or GPL * Version 2] license." If you don't indicate a single choice of license, a * recipient has the option to distribute your version of this file under * either the CDDL, the GPL Version 2 or to extend the choice of license to * its licensees as provided above. However, if you add GPL Version 2 code * and therefore, elected the GPL Version 2 license, then the option applies * only if the new code is made subject to such option by the copyright * holder. * * * This file incorporates work covered by the following copyright and * permission notice: * * Copyright 2004 The Apache Software Foundation * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ package org.apache.naming.resources; import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.Date; import java.util.Locale; import java.util.TimeZone; import java.util.Vector; import javax.naming.NamingEnumeration; import javax.naming.NamingException; import javax.naming.directory.Attribute; import javax.naming.directory.Attributes; import javax.naming.directory.BasicAttribute; /** * Attributes implementation. * * @author Remy Maucherat * @version $Revision: 1.1.2.1 $ */ public class ResourceAttributes implements Attributes { // -------------------------------------------------------------- Constants // Default attribute names /** * Creation date. */ public static final String CREATION_DATE = "creationdate"; /** * Creation date. */ public static final String ALTERNATE_CREATION_DATE = "creation-date"; /** * Last modification date. */ public static final String LAST_MODIFIED = "getlastmodified"; /** * Last modification date. */ public static final String ALTERNATE_LAST_MODIFIED = "last-modified"; /** * Name. */ public static final String NAME = "displayname"; /** * Type. */ public static final String TYPE = "resourcetype"; /** * Type. */ public static final String ALTERNATE_TYPE = "content-type"; /** * Source. */ public static final String SOURCE = "source"; /** * MIME type of the content. */ public static final String CONTENT_TYPE = "getcontenttype"; /** * Content language. */ public static final String CONTENT_LANGUAGE = "getcontentlanguage"; /** * Content length. */ public static final String CONTENT_LENGTH = "getcontentlength"; /** * Content length. */ public static final String ALTERNATE_CONTENT_LENGTH = "content-length"; /** * ETag. */ public static final String ETAG = "getetag"; /** * ETag. */ public static final String ALTERNATE_ETAG = "etag"; /** * Collection type. */ public static final String COLLECTION_TYPE = ""; protected final static TimeZone gmtZone = TimeZone.getTimeZone("GMT"); /** * HTTP date format. */ protected static final ThreadLocal FORMAT = new ThreadLocal() { @Override protected SimpleDateFormat initialValue() { SimpleDateFormat f = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss zzz", Locale.US); f.setTimeZone(gmtZone); return f; } }; /** * Date formats using for Date parsing. */ protected static final ThreadLocal FORMATS = new ThreadLocal() { @Override protected Object initialValue() { SimpleDateFormat f[] = new SimpleDateFormat[3]; f[0] = new SimpleDateFormat("EEE, dd MMM yyyy HH:mm:ss zzz", Locale.US); f[0].setTimeZone(gmtZone); f[1] = new SimpleDateFormat("EEEEEE, dd-MMM-yy HH:mm:ss zzz", Locale.US); f[1].setTimeZone(gmtZone); f[2] = new SimpleDateFormat("EEE MMMM d HH:mm:ss yyyy", Locale.US); f[2].setTimeZone(gmtZone); return f; } }; // ----------------------------------------------------------- Constructors /** * Default constructor. */ public ResourceAttributes() { } /** * Merges with another attribute set. */ public ResourceAttributes(Attributes attributes) { this.attributes = attributes; } // ----------------------------------------------------- Instance Variables /** * Collection flag. */ protected boolean collection = false; /** * Content length. */ protected long contentLength = -1; /** * Creation time. */ protected long creation = -1; /** * Creation date. */ protected Date creationDate = null; /** * Last modified time. */ protected long lastModified = -1; /** * Last modified date. */ protected Date lastModifiedDate = null; /** * Last modified date in HTTP format. */ protected String lastModifiedHttp = null; /** * MIME type. */ protected String mimeType = null; /** * Name. */ protected String name = null; /** * Weak ETag. */ protected String weakETag = null; /** * Strong ETag. */ protected String strongETag = null; /** * External attributes. */ protected Attributes attributes = null; // ------------------------------------------------------------- Properties /** * Is collection. */ public boolean isCollection() { if (attributes != null) { return (COLLECTION_TYPE.equals(getResourceType())); } else { return (collection); } } /** * Set collection flag. */ public void setCollection(boolean collection) { this.collection = collection; if (attributes != null) { String value = ""; if (collection) value = COLLECTION_TYPE; attributes.put(TYPE, value); } } /** * Get content length. * * @return content length value */ public long getContentLength() { if (contentLength != -1L) return contentLength; if (attributes != null) { Attribute attribute = attributes.get(CONTENT_LENGTH); if (attribute != null) { try { Object value = attribute.get(); if (value instanceof Long) { contentLength = ((Long) value).longValue(); } else { try { contentLength = Long.parseLong(value.toString()); } catch (NumberFormatException e) { // Ignore } } } catch (NamingException e) { // No value for the attribute } } } return contentLength; } /** * Set content length. * * @param contentLength New content length value */ public void setContentLength(long contentLength) { this.contentLength = contentLength; if (attributes != null) attributes.put(CONTENT_LENGTH, Long.valueOf(contentLength)); } /** * Get creation time. * * @return creation time value */ public long getCreation() { if (creation != -1L) return creation; if (creationDate != null) return creationDate.getTime(); if (attributes != null) { Attribute attribute = attributes.get(CREATION_DATE); if (attribute != null) { try { Object value = attribute.get(); if (value instanceof Long) { creation = ((Long) value).longValue(); } else if (value instanceof Date) { creation = ((Date) value).getTime(); creationDate = (Date) value; } else { String creationDateValue = value.toString(); Date result = null; // Parsing the HTTP Date SimpleDateFormat[] formats = (SimpleDateFormat[])FORMATS.get(); for (int i = 0; (result == null) && (i < formats.length); i++) { try { result = formats[i].parse(creationDateValue); } catch (ParseException e) { // Ignore } } if (result != null) { creation = result.getTime(); creationDate = result; } } } catch (NamingException e) { // No value for the attribute } } } return creation; } /** * Set creation. * * @param creation New creation value */ public void setCreation(long creation) { this.creation = creation; this.creationDate = null; if (attributes != null) attributes.put(CREATION_DATE, new Date(creation)); } /** * Get creation date. * * @return Creation date value */ public Date getCreationDate() { if (creationDate != null) return creationDate; if (creation != -1L) { creationDate = new Date(creation); return creationDate; } if (attributes != null) { Attribute attribute = attributes.get(CREATION_DATE); if (attribute != null) { try { Object value = attribute.get(); if (value instanceof Long) { creation = ((Long) value).longValue(); creationDate = new Date(creation); } else if (value instanceof Date) { creation = ((Date) value).getTime(); creationDate = (Date) value; } else { String creationDateValue = value.toString(); Date result = null; // Parsing the HTTP Date SimpleDateFormat[] formats = (SimpleDateFormat[])FORMATS.get(); for (int i = 0; (result == null) && (i < formats.length); i++) { try { result = formats[i].parse(creationDateValue); } catch (ParseException e) { // Ignore } } if (result != null) { creation = result.getTime(); creationDate = result; } } } catch (NamingException e) { // No value for the attribute } } } return creationDate; } /** * Creation date mutator. * * @param creationDate New creation date */ public void setCreationDate(Date creationDate) { this.creation = creationDate.getTime(); this.creationDate = creationDate; if (attributes != null) attributes.put(CREATION_DATE, creationDate); } /** * Get last modified time. * * @return lastModified time value */ public long getLastModified() { if (lastModified != -1L) return lastModified; if (lastModifiedDate != null) return lastModifiedDate.getTime(); if (attributes != null) { Attribute attribute = attributes.get(LAST_MODIFIED); if (attribute != null) { try { Object value = attribute.get(); if (value instanceof Long) { lastModified = ((Long) value).longValue(); } else if (value instanceof Date) { lastModified = ((Date) value).getTime(); lastModifiedDate = (Date) value; } else { String lastModifiedDateValue = value.toString(); Date result = null; // Parsing the HTTP Date SimpleDateFormat[] formats = (SimpleDateFormat[])FORMATS.get(); for (int i = 0; (result == null) && (i < formats.length); i++) { try { result = formats[i].parse(lastModifiedDateValue); } catch (ParseException e) { // Ignore } } if (result != null) { lastModified = result.getTime(); lastModifiedDate = result; } } } catch (NamingException e) { // No value for the attribute } } } return lastModified; } /** * Set last modified. * * @param lastModified New last modified value */ public void setLastModified(long lastModified) { this.lastModified = lastModified; this.lastModifiedDate = null; if (attributes != null) attributes.put(LAST_MODIFIED, new Date(lastModified)); } /** * Set last modified date. * * @param lastModified New last modified date value * @deprecated */ public void setLastModified(Date lastModified) { setLastModifiedDate(lastModified); } /** * Get lastModified date. * * @return LastModified date value */ public Date getLastModifiedDate() { if (lastModifiedDate != null) return lastModifiedDate; if (lastModified != -1L) { lastModifiedDate = new Date(lastModified); return lastModifiedDate; } if (attributes != null) { Attribute attribute = attributes.get(LAST_MODIFIED); if (attribute != null) { try { Object value = attribute.get(); if (value instanceof Long) { lastModified = ((Long) value).longValue(); lastModifiedDate = new Date(lastModified); } else if (value instanceof Date) { lastModified = ((Date) value).getTime(); lastModifiedDate = (Date) value; } else { String lastModifiedDateValue = value.toString(); Date result = null; // Parsing the HTTP Date SimpleDateFormat[] formats = (SimpleDateFormat[])FORMATS.get(); for (int i = 0; (result == null) && (i < formats.length); i++) { try { result = formats[i].parse(lastModifiedDateValue); } catch (ParseException e) { // Ignore } } if (result != null) { lastModified = result.getTime(); lastModifiedDate = result; } } } catch (NamingException e) { // No value for the attribute } } } return lastModifiedDate; } /** * Last modified date mutator. * * @param lastModifiedDate New last modified date */ public void setLastModifiedDate(Date lastModifiedDate) { this.lastModified = lastModifiedDate.getTime(); this.lastModifiedDate = lastModifiedDate; if (attributes != null) attributes.put(LAST_MODIFIED, lastModifiedDate); } /** * @return Returns the lastModifiedHttp. */ public String getLastModifiedHttp() { if (lastModifiedHttp != null) return lastModifiedHttp; Date modifiedDate = getLastModifiedDate(); if (modifiedDate == null) { modifiedDate = getCreationDate(); } if (modifiedDate == null) { modifiedDate = new Date(); } lastModifiedHttp = FORMAT.get().format(modifiedDate); return lastModifiedHttp; } /** * @return the creation or lastModified date */ public Date getCreationOrLastModifiedDate() { Date modifiedDate = getLastModifiedDate(); if (modifiedDate == null) { modifiedDate = getCreationDate(); } if (modifiedDate == null) { modifiedDate = new Date(); } return modifiedDate; } /** * @param lastModifiedHttp The lastModifiedHttp to set. */ public void setLastModifiedHttp(String lastModifiedHttp) { this.lastModifiedHttp = lastModifiedHttp; } /** * @return Returns the mimeType. */ public String getMimeType() { return mimeType; } /** * @param mimeType The mimeType to set. */ public void setMimeType(String mimeType) { this.mimeType = mimeType; } /** * Get name. * * @return Name value */ public String getName() { if (name != null) return name; if (attributes != null) { Attribute attribute = attributes.get(NAME); if (attribute != null) { try { name = attribute.get().toString(); } catch (NamingException e) { ; // No value for the attribute } } } return name; } /** * Set name. * * @param name New name value */ public void setName(String name) { this.name = name; if (attributes != null) attributes.put(NAME, name); } /** * Get resource type. * * @return String resource type */ public String getResourceType() { String result = null; if (attributes != null) { Attribute attribute = attributes.get(TYPE); if (attribute != null) { try { result = attribute.get().toString(); } catch (NamingException e) { ; // No value for the attribute } } } if (result == null) { if (collection) result = COLLECTION_TYPE; else result = null; } return result; } /** * Type mutator. * * @param resourceType New resource type */ public void setResourceType(String resourceType) { collection = resourceType.equals(COLLECTION_TYPE); if (attributes != null) attributes.put(TYPE, resourceType); } /** * Get ETag. * * @return strong ETag if available, else weak ETag */ public String getETag() { String result = null; if (attributes != null) { Attribute attribute = attributes.get(ETAG); if (attribute != null) { try { result = attribute.get().toString(); } catch (NamingException e) { ; // No value for the attribute } } } if (result == null) { if (strongETag != null) { // The strong ETag must always be calculated by the resources result = strongETag; } else { // The weakETag is contentLength + lastModified if (weakETag == null) { long contentLength = getContentLength(); long lastModified = getLastModified(); if ((contentLength >= 0) || (lastModified >= 0)) { weakETag = "W/\"" + contentLength + "-" + lastModified + "\""; } } result = weakETag; } } return result; } /** * Get ETag. * * @param strong Ignored * @return strong ETag if available, else weak ETag. * @deprecated */ public String getETag(boolean strong) { return getETag(); } /** * Set strong ETag. */ public void setETag(String eTag) { this.strongETag = eTag; if (attributes != null) attributes.put(ETAG, eTag); } /** * Return the canonical path of the resource, to possibly be used for * direct file serving. Implementations which support this should override * it to return the file path. * * @return The canonical path of the resource */ public String getCanonicalPath() { return null; } // ----------------------------------------------------- Attributes Methods /** * Get attribute. */ public Attribute get(String attrID) { if (attributes == null) { if (attrID.equals(CREATION_DATE)) { Date creationDate = getCreationDate(); if (creationDate == null) return null; return new BasicAttribute(CREATION_DATE, creationDate); } else if (attrID.equals(ALTERNATE_CREATION_DATE)) { Date creationDate = getCreationDate(); if (creationDate == null) return null; return new BasicAttribute(ALTERNATE_CREATION_DATE, creationDate); } else if (attrID.equals(LAST_MODIFIED)) { Date lastModifiedDate = getLastModifiedDate(); if (lastModifiedDate == null) return null; return new BasicAttribute(LAST_MODIFIED, lastModifiedDate); } else if (attrID.equals(ALTERNATE_LAST_MODIFIED)) { Date lastModifiedDate = getLastModifiedDate(); if (lastModifiedDate == null) return null; return new BasicAttribute(ALTERNATE_LAST_MODIFIED, lastModifiedDate); } else if (attrID.equals(NAME)) { String name = getName(); if (name == null) return null; return new BasicAttribute(NAME, name); } else if (attrID.equals(TYPE)) { String resourceType = getResourceType(); if (resourceType == null) return null; return new BasicAttribute(TYPE, resourceType); } else if (attrID.equals(ALTERNATE_TYPE)) { String resourceType = getResourceType(); if (resourceType == null) return null; return new BasicAttribute(ALTERNATE_TYPE, resourceType); } else if (attrID.equals(CONTENT_LENGTH)) { long contentLength = getContentLength(); if (contentLength < 0) return null; return new BasicAttribute(CONTENT_LENGTH, Long.valueOf(contentLength)); } else if (attrID.equals(ALTERNATE_CONTENT_LENGTH)) { long contentLength = getContentLength(); if (contentLength < 0) return null; return new BasicAttribute(ALTERNATE_CONTENT_LENGTH, Long.valueOf(contentLength)); } else if (attrID.equals(ETAG)) { String etag = getETag(); if (etag == null) return null; return new BasicAttribute(ETAG, etag); } else if (attrID.equals(ALTERNATE_ETAG)) { String etag = getETag(); if (etag == null) return null; return new BasicAttribute(ALTERNATE_ETAG, etag); } } else { return attributes.get(attrID); } return null; } /** * Put attribute. */ public Attribute put(Attribute attribute) { if (attributes == null) { try { return put(attribute.getID(), attribute.get()); } catch (NamingException e) { return null; } } else { return attributes.put(attribute); } } /** * Put attribute. */ public Attribute put(String attrID, Object val) { if (attributes == null) { return null; // No reason to implement this } else { return attributes.put(attrID, val); } } /** * Remove attribute. */ public Attribute remove(String attrID) { if (attributes == null) { return null; // No reason to implement this } else { return attributes.remove(attrID); } } /** * Get all attributes. */ public NamingEnumeration getAll() { if (attributes == null) { Vector attributes = new Vector(); Date creationDate = getCreationDate(); if (creationDate != null) { attributes.addElement(new BasicAttribute (CREATION_DATE, creationDate)); attributes.addElement(new BasicAttribute (ALTERNATE_CREATION_DATE, creationDate)); } Date lastModifiedDate = getLastModifiedDate(); if (lastModifiedDate != null) { attributes.addElement(new BasicAttribute (LAST_MODIFIED, lastModifiedDate)); attributes.addElement(new BasicAttribute (ALTERNATE_LAST_MODIFIED, lastModifiedDate)); } String name = getName(); if (name != null) { attributes.addElement(new BasicAttribute(NAME, name)); } String resourceType = getResourceType(); if (resourceType != null) { attributes.addElement(new BasicAttribute(TYPE, resourceType)); attributes.addElement(new BasicAttribute(ALTERNATE_TYPE, resourceType)); } long contentLength = getContentLength(); if (contentLength >= 0) { Long contentLengthLong = Long.valueOf(contentLength); attributes.addElement(new BasicAttribute(CONTENT_LENGTH, contentLengthLong)); attributes.addElement(new BasicAttribute(ALTERNATE_CONTENT_LENGTH, contentLengthLong)); } String etag = getETag(); if (etag != null) { attributes.addElement(new BasicAttribute(ETAG, etag)); attributes.addElement(new BasicAttribute(ALTERNATE_ETAG, etag)); } return new RecyclableNamingEnumeration(attributes); } else { return attributes.getAll(); } } /** * Get all attribute IDs. */ public NamingEnumeration getIDs() { if (attributes == null) { Vector attributeIDs = new Vector(); Date creationDate = getCreationDate(); if (creationDate != null) { attributeIDs.addElement(CREATION_DATE); attributeIDs.addElement(ALTERNATE_CREATION_DATE); } Date lastModifiedDate = getLastModifiedDate(); if (lastModifiedDate != null) { attributeIDs.addElement(LAST_MODIFIED); attributeIDs.addElement(ALTERNATE_LAST_MODIFIED); } if (getName() != null) { attributeIDs.addElement(NAME); } String resourceType = getResourceType(); if (resourceType != null) { attributeIDs.addElement(TYPE); attributeIDs.addElement(ALTERNATE_TYPE); } long contentLength = getContentLength(); if (contentLength >= 0) { attributeIDs.addElement(CONTENT_LENGTH); attributeIDs.addElement(ALTERNATE_CONTENT_LENGTH); } String etag = getETag(); if (etag != null) { attributeIDs.addElement(ETAG); attributeIDs.addElement(ALTERNATE_ETAG); } return new RecyclableNamingEnumeration(attributeIDs); } else { return attributes.getIDs(); } } /** * Retrieves the number of attributes in the attribute set. */ public int size() { if (attributes == null) { int size = 0; if (getCreationDate() != null) size += 2; if (getLastModifiedDate() != null) size += 2; if (getName() != null) size++; if (getResourceType() != null) size += 2; if (getContentLength() >= 0) size += 2; if (getETag() != null) size += 2; return size; } else { return attributes.size(); } } /** * Clone the attributes object */ public Object clone() { try { return super.clone(); } catch (CloneNotSupportedException e) { throw new RuntimeException(e); } } /** * Case sensitivity. */ public boolean isCaseIgnored() { return false; } }