Changeset 5594


Ignore:
Timestamp:
08/22/14 12:01:57 (10 years ago)
Author:
Twan Goosen
Message:

Added REST service information to the help page. Moved the documentation into a separate 'doc' directory in the project.
Refs #614

Location:
VirtualCollectionRegistry/trunk/VirtualCollectionRegistry
Files:
1 added
6 edited
5 moved

Legend:

Unmodified
Added
Removed

  • VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/doc/README.txt

    r5579 r5594  
    2727  NOTE: currently only MySQL is supported.
    2828
     29* CONTEXT PARAMETERS *
     30
     31PUBLIC APPLICATION URL:
     32
     33Add the following context parameter (typically to the global context.xml file)
     34and substitute the value with the correct *public* base location of the VCR:
     35
     36  <Parameter name="eu.clarin.cmdi.virtualcollectionregistry.base_uri"
     37             value="http://my/server/VirtualCollectionRegistry"
     38             override="false"/>
     39
     40Add no trailing slash. You can verify this by checking the service links in the
     41help page of the running application.
     42
     43ADMINISTRATOR USERS:
     44
     45Add the following context parameter:
     46
     47<Parameter
     48           name="eu.clarin.cmdi.virtualcollectionregistry.admindb"
     49           value="/path/to/vcr-admin.conf" />
     50
     51Add the username of each user that should get administrator rights to the
     52referenced file, one username per line.
     53
    2954* PID PROVIDER *
    3055
    … …  
    4368             value="vcr.pid.gwdg"
    4469             override="false"/>   
    45   <Parameter name="pid_provider.base_uri"
    46              value="http://127.0.0.1:8080/VirtualCollectionRegistry"
    47              override="false"/>
    4870  <Parameter name="pid_provider.username" value="$gwdg_user" override="false"/>
    4971  <Parameter name="pid_provider.password" value="$gwdg_password" override="false"/>
    … …  
    5577             value="vcr.pid.epic”
    5678             override="false"/>   
    57   <Parameter name="pid_provider.base_uri"
    58              value="http://127.0.0.1:8080/VirtualCollectionRegistry"
    59              override="false"/>
    6079
    6180* AUTHENTICATION *
    … …  
    104123Change the value of the 'value' attribute if desired. If this parameter is not set,
    105124the default value "CLARIN Virtual Collection Registry" will be used as a collection name.
    106 
    107 * ADMINISTRATOR USERS *
    108 
    109 Add the following context parameter:
    110 
    111 <Parameter
    112            name="eu.clarin.cmdi.virtualcollectionregistry.admindb"
    113            value="/path/to/vcr-admin.conf" />
    114 
    115 Add the username of each user that should get administrator rights to the referenced
    116 file, one username per line.

  • VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/pom.xml

    r5588 r5594  
    548548                <groupId>org.apache.maven.plugins</groupId>
    549549                <artifactId>maven-war-plugin</artifactId>
    550                 <version>2.1.1</version>
     550                <version>2.4</version>
    551551                <configuration>
    552552                    <failOnMissingWebXml>true</failOnMissingWebXml>
    … …  
    560560                                <include>*.xsd</include>
    561561                            </includes>
     562                        </resource>
     563                        <!-- Make documentation available -->
     564                        <resource>
     565                            <directory>doc</directory>
    562566                        </resource>
    563567                    </webResources>

  • VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/assembly/distribution.xml

    r5591 r5594  
    99    <fileSets>
    1010        <fileSet>
    11             <directory>${project.basedir}</directory>
     11            <directory>${project.basedir}/doc</directory>
    1212            <outputDirectory>/doc</outputDirectory>
    13             <includes>
    14                 <include>README*</include>
    15                 <include>LICENSE*</include>
    16                 <include>NOTICE*</include>
    17                 <include>Protocol.txt</include>
    18             </includes>
    1913        </fileSet>
    2014        <fileSet>

  • VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/pages/HelpPage.html

    r5593 r5594  
    88        <wicket:extend>
    99            <div id="help">
    10                 <h1>Definitions</h1>
    11                 <h3>Collection types</h3>
     10                <h1>Glossary</h1>
     11                <h2>Collection types</h2>
    1212                <dl>
    1313                    <dt>extensional</dt>
    … …  
    1717                            <dt>resources</dt>
    1818                            <dd>
    19                                 The members that make up the virtual collection by means of a persistent reference.
     19                                The members that make up an extensional virtual collection by means of a persistent reference.
    2020                                These members may be of type <em>metadata</em> for referencing metadata, or <em>resource</em> for directly referencing a resource.
    2121                            </dd>
    … …  
    4747                </dl>
    4848
    49                 <h3>General collection properties</h3>
     49                <h2>General collection properties</h2>
    5050                <dl>                   
    5151                    <dt>purpose</dt>
    … …  
    106106                </dl>
    107107
     108                <h2>REST service</h2>
     109                <p>
     110                    The Virtual Collection Registry REST service is accessible
     111                    at <a wicket:id="restLink"><wicket:container wicket:id="restUrl">[url]</wicket:container></a> (base URL).
     112                </p>
     113                <p>
     114                    Documentation can be found <a href="Protocol.txt">here</a>.
     115                    You can also consult the <a wicket:id="wadlLink">WADL</a> file.
     116                </p>
    108117            </div>
    109118        </wicket:extend>

  • VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/gui/pages/HelpPage.java

    r5593 r5594  
    1515 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
    1616 */
     17package eu.clarin.cmdi.virtualcollectionregistry.gui.pages;
    1718
    18 package eu.clarin.cmdi.virtualcollectionregistry.gui.pages;
     19import org.apache.wicket.markup.html.basic.Label;
     20import org.apache.wicket.markup.html.link.ExternalLink;
     21import org.apache.wicket.protocol.http.WebApplication;
    1922
    2023/**
    … …  
    2326 */
    2427public class HelpPage extends BasePage {
    25    
     28
     29    public static final String BASE_URI = "eu.clarin.cmdi.virtualcollectionregistry.base_uri";
     30
     31    public HelpPage() {
     32        final String baseUri = WebApplication.get().getServletContext().getInitParameter(BASE_URI);
     33        final String serviceBaseUri = String.format("%s/service", baseUri);
     34
     35        add(new ExternalLink("restLink", serviceBaseUri)
     36                .add(new Label("restUrl", serviceBaseUri)));
     37        add(new ExternalLink("wadlLink", String.format("%s/application.wadl", serviceBaseUri)));
     38    }
     39
    2640}

  • VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/pid/EPICPersistentIdentifierProvider.java

    r5539 r5594  
    99import java.util.EnumMap;
    1010import java.util.Map;
    11 import java.util.UUID;
    12 import java.util.zip.CRC32;
    13 import org.apache.commons.codec.binary.Base64;
    1411import org.apache.commons.httpclient.HttpException;
    1512import org.slf4j.Logger;
    … …  
    3835    private final Configuration configuration;
    3936
    40     @Value("${pid_provider.base_uri}")
     37    @Value("${eu.clarin.cmdi.virtualcollectionregistry.base_uri}")
    4138    private String baseUri;
    4239

  • VirtualCollectionRegistry/trunk/VirtualCollectionRegistry/src/main/java/eu/clarin/cmdi/virtualcollectionregistry/pid/GWDGPersistentIdentifierProvider.java

    r5587 r5594  
    4343        PersistentIdentifierProvider {
    4444
    45     public static final String BASE_URI = "pid_provider.base_uri";
     45    public static final String BASE_URI = "eu.clarin.cmdi.virtualcollectionregistry.base_uri";
    4646
    4747    private static enum Attribute {
Note: See TracChangeset for help on using the changeset viewer.