| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You 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. |
| * |
| */ |
| /* |
| * Licensed to the Apache Software Foundation (ASF) under one or more |
| * contributor license agreements. See the NOTICE file distributed with |
| * this work for additional information regarding copyright ownership. |
| * The ASF licenses this file to You 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.lenya.cms.publication; |
| |
| import java.util.Date; |
| |
| import org.apache.lenya.util.Assert; |
| import org.apache.lenya.xml.Schema; |
| |
| /** |
| * @version $Id:$ |
| */ |
| public interface ResourceType { |
| |
| /** |
| * The Avalon service role. |
| */ |
| String ROLE = ResourceType.class.getName(); |
| |
| /** |
| * Prefix for translating the resource type name, e.g. |
| * <i18n:text>resourceType-<jx:out |
| * value="${resourceType.getName()}"/></i18n:text> |
| */ |
| String I18N_PREFIX = "resourceType-"; |
| |
| /** |
| * Returns the date at which point the requested resource is considered |
| * expired |
| * @return a string in RFC 1123 date format |
| */ |
| Date getExpires(); |
| |
| /** |
| * Returns the name of this document type. |
| * @return A string value. |
| */ |
| String getName(); |
| |
| /** |
| * @return The source URI of the RelaxNG schema. |
| */ |
| Schema getSchema(); |
| |
| /** |
| * Returns an array of XPaths representing attributes to be rewritten when a |
| * document URL has changed. |
| * @return An array of strings. |
| */ |
| String[] getLinkAttributeXPaths(); |
| |
| /** |
| * @return The names of all available samples. The first one is the default sample. |
| */ |
| String[] getSampleNames(); |
| |
| /** |
| * @param name The name. |
| * @return The sample with the specified name. |
| */ |
| Sample getSample(String name); |
| |
| /** |
| * @param name The name of the resource type. |
| */ |
| void setName(String name); |
| |
| /** |
| * @return All supported formats. |
| */ |
| String[] getFormats(); |
| |
| /** |
| * @param format The format. |
| * @return The URI to get the formatted content at. |
| */ |
| String getFormatURI(String format); |
| |
| /** |
| * A resource type sample. |
| */ |
| public static class Sample { |
| |
| protected Sample(String name, String mimeType, String uri) { |
| Assert.notNull("name", name); |
| this.name = name; |
| Assert.notNull("mimeType", mimeType); |
| this.mimeType = mimeType; |
| Assert.notNull("uri", uri); |
| this.uri = uri; |
| } |
| |
| private String name; |
| private String mimeType; |
| private String uri; |
| |
| /** |
| * @return The name of the sample. |
| */ |
| public String getName() { |
| return this.name; |
| } |
| |
| /** |
| * @return The MIME type of the sample. |
| */ |
| public String getMimeType() { |
| return this.mimeType; |
| } |
| |
| /** |
| * @return The URI of the sample source. |
| */ |
| public String getUri() { |
| return this.uri; |
| } |
| |
| } |
| |
| } |