001/**
002 * Java Web Archive Toolkit - Software to read and validate ARC, WARC
003 * and GZip files. (http://jwat.org/)
004 * Copyright 2011-2012 Netarkivet.dk (http://netarkivet.dk/)
005 *
006 * Licensed under the Apache License, Version 2.0 (the "License");
007 * you may not use this file except in compliance with the License.
008 * You may obtain a copy of the License at
009 *
010 * http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.jwat.warc;
019
020/**
021 * WARC/1.0 specification validation relevant information.
022 *
023 * @author nicl
024 */
025public class WarcValidator10 extends WarcValidatorBase {
026
027    public WarcValidator10(int[] arr) {
028        setVersions(arr);
029        field_policy = new int[RT_INDEX_OF_LAST][FN_INDEX_OF_LAST];
030        setWarcHeaderPolicyMatrix();
031    }
032
033    /**
034     * Initialize a multi-array with the WARC/1.0 type/header policies.
035     * @param field_policy policy multi-array to initialize
036     */
037    public static final void setWarc10HeaderPolicyMatrix(int[][] field_policy) {
038        // Warc-Record-id
039        // Warc-Type
040        // Warc-Date
041        // Content-Length
042        // Also required for unknown warc-types.
043        for (int i=0; i<=RT_NUMBER; ++i) {
044            field_policy[i][FN_IDX_WARC_RECORD_ID] = POLICY_MANDATORY;
045            field_policy[i][FN_IDX_WARC_TYPE] = POLICY_MANDATORY;
046            field_policy[i][FN_IDX_WARC_DATE] = POLICY_MANDATORY;
047            field_policy[i][FN_IDX_CONTENT_LENGTH] = POLICY_MANDATORY;
048        }
049
050        // Content-Type
051        field_policy[RT_IDX_CONTINUATION][FN_IDX_CONTENT_TYPE] = POLICY_SHALL_NOT;
052
053        // Warc-Ip-Address
054        field_policy[RT_IDX_REQUEST][FN_IDX_WARC_IP_ADDRESS] = POLICY_MAY;
055        field_policy[RT_IDX_RESPONSE][FN_IDX_WARC_IP_ADDRESS] = POLICY_MAY;
056        field_policy[RT_IDX_RESOURCE][FN_IDX_WARC_IP_ADDRESS] = POLICY_MAY;
057        field_policy[RT_IDX_METADATA][FN_IDX_WARC_IP_ADDRESS] = POLICY_MAY;
058        field_policy[RT_IDX_REVISIT][FN_IDX_WARC_IP_ADDRESS] = POLICY_MAY;
059        field_policy[RT_IDX_WARCINFO][FN_IDX_WARC_IP_ADDRESS] = POLICY_SHALL_NOT;
060        field_policy[RT_IDX_CONVERSION][FN_IDX_WARC_IP_ADDRESS] = POLICY_SHALL_NOT;
061        field_policy[RT_IDX_CONTINUATION][FN_IDX_WARC_IP_ADDRESS] = POLICY_SHALL_NOT;
062
063        // Warc-Concurrent-To
064        field_policy[RT_IDX_REQUEST][FN_IDX_WARC_CONCURRENT_TO] = POLICY_MAY;
065        field_policy[RT_IDX_RESPONSE][FN_IDX_WARC_CONCURRENT_TO] = POLICY_MAY;
066        field_policy[RT_IDX_RESOURCE][FN_IDX_WARC_CONCURRENT_TO] = POLICY_MAY;
067        field_policy[RT_IDX_METADATA][FN_IDX_WARC_CONCURRENT_TO] = POLICY_MAY;
068        field_policy[RT_IDX_REVISIT][FN_IDX_WARC_CONCURRENT_TO] = POLICY_MAY;
069        field_policy[RT_IDX_WARCINFO][FN_IDX_WARC_CONCURRENT_TO] = POLICY_SHALL_NOT;
070        field_policy[RT_IDX_CONVERSION][FN_IDX_WARC_CONCURRENT_TO] = POLICY_SHALL_NOT;
071        field_policy[RT_IDX_CONTINUATION][FN_IDX_WARC_CONCURRENT_TO] = POLICY_SHALL_NOT;
072
073        // Warc-Refers-To
074        field_policy[RT_IDX_METADATA][FN_IDX_WARC_REFERS_TO] = POLICY_MAY;
075        field_policy[RT_IDX_CONVERSION][FN_IDX_WARC_REFERS_TO] = POLICY_MAY;
076        field_policy[RT_IDX_REVISIT][FN_IDX_WARC_REFERS_TO] = POLICY_MAY;
077        field_policy[RT_IDX_WARCINFO][FN_IDX_WARC_REFERS_TO] = POLICY_SHALL_NOT;
078        field_policy[RT_IDX_REQUEST][FN_IDX_WARC_REFERS_TO] = POLICY_SHALL_NOT;
079        field_policy[RT_IDX_RESPONSE][FN_IDX_WARC_REFERS_TO] = POLICY_SHALL_NOT;
080        field_policy[RT_IDX_RESOURCE][FN_IDX_WARC_REFERS_TO] = POLICY_SHALL_NOT;
081        field_policy[RT_IDX_CONTINUATION][FN_IDX_WARC_REFERS_TO] = POLICY_SHALL_NOT;
082
083        // Warc-Target-Uri
084        field_policy[RT_IDX_REQUEST][FN_IDX_WARC_TARGET_URI] = POLICY_SHALL;
085        field_policy[RT_IDX_RESPONSE][FN_IDX_WARC_TARGET_URI] = POLICY_SHALL;
086        field_policy[RT_IDX_RESOURCE][FN_IDX_WARC_TARGET_URI] = POLICY_SHALL;
087        field_policy[RT_IDX_CONVERSION][FN_IDX_WARC_TARGET_URI] = POLICY_SHALL;
088        field_policy[RT_IDX_CONTINUATION][FN_IDX_WARC_TARGET_URI] = POLICY_SHALL;
089        field_policy[RT_IDX_REVISIT][FN_IDX_WARC_TARGET_URI] = POLICY_SHALL;
090        field_policy[RT_IDX_METADATA][FN_IDX_WARC_TARGET_URI] = POLICY_MAY;
091        field_policy[RT_IDX_WARCINFO][FN_IDX_WARC_TARGET_URI] = POLICY_SHALL_NOT;
092
093        // Warc-Warcinfo-Id
094        // Warc-Filename
095        // Warc-Profile
096        // Warc-Segment-Origin-Id
097        // Warc-Segment-Total-Length
098        for (int i=1; i<=RT_NUMBER; ++i) {
099            field_policy[i][FN_IDX_WARC_WARCINFO_ID] = POLICY_MAY;
100            field_policy[i][FN_IDX_WARC_FILENAME] = POLICY_SHALL_NOT;
101            field_policy[i][FN_IDX_WARC_PROFILE] = POLICY_IGNORE;
102            field_policy[i][FN_IDX_WARC_SEGMENT_ORIGIN_ID] = POLICY_SHALL_NOT;
103            field_policy[i][FN_IDX_WARC_SEGMENT_ORIGIN_ID] = POLICY_SHALL_NOT;
104        }
105        field_policy[RT_IDX_WARCINFO][FN_IDX_WARC_WARCINFO_ID] = POLICY_MAY_NOT;
106        field_policy[RT_IDX_WARCINFO][FN_IDX_WARC_FILENAME] = POLICY_MAY;
107        field_policy[RT_IDX_REVISIT][FN_IDX_WARC_PROFILE] = POLICY_MANDATORY;
108        field_policy[RT_IDX_CONTINUATION][FN_IDX_WARC_SEGMENT_ORIGIN_ID] = POLICY_MANDATORY;
109
110        // Warc-Segment-Number
111        field_policy[RT_IDX_CONTINUATION][FN_IDX_WARC_SEGMENT_NUMBER] = POLICY_MANDATORY;
112    }
113
114    @Override
115    public void setWarcHeaderPolicyMatrix() {
116        setWarc10HeaderPolicyMatrix(field_policy);
117        // WARC-Refers-To-Target-URI
118        // WARC-Refers-To-Date
119        for (int i=1; i<=RT_NUMBER; ++i) {
120            field_policy[i][FN_IDX_WARC_REFERS_TO_TARGET_URI] = POLICY_IGNORE;
121            field_policy[i][FN_IDX_WARC_REFERS_TO_DATE] = POLICY_IGNORE;
122        }
123    }
124
125}