ParameterTypes.scala 4.17 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
/*
 * generic OAI Server - agnostic in relation to the data repository
 * initially created for memobase project
 *
 * Copyright (C) 2021  UB Basel
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 *
 */


23
24
package org.swissbib.memobase.oai.common.validation

25
26
import org.swissbib.memobase.oai.common.util.ResumptionToken
import org.swissbib.memobase.oai.common.verb.OaiVerb.{GetRecord, Identify, ListIdentifiers, ListMetadataFormats, ListRecords, ListSets, OaiVerb}
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

sealed abstract class OaiParameterBase() extends Product with Serializable {
  def listRequestParameters: Map[String,String]
}

case class ParameterToCheck(verb:Option[OaiVerb],
                            metadataPrefix: Option[String],
                            set: Option[String],
                            from:Option[String],
                            until:Option[String],
                            identifier: Option[String],
                            resumptionToken: Option[String],
                            allQueryParameter: Map[String, Seq[String]]) extends OaiParameterBase {
  override def listRequestParameters: Map[String, String] = Map()
}



case class CheckedIdentifyParameter (verb:OaiVerb) extends OaiParameterBase {
  require(verb == Identify)

  override def listRequestParameters: Map[String, String] = Map()
}

case class CheckedGetRecordParameter (verb:OaiVerb, identifier: String, metadataPrefix: String) extends OaiParameterBase {
  require(verb == GetRecord)
  override def listRequestParameters: Map[String, String] = Map()

}

case class CheckedListIdentifiersParameter (verb:OaiVerb, metadataPrefix: String, set:Option[String],
                                            from:Option[String], until:Option[String]) extends OaiParameterBase {
  require(verb == ListIdentifiers)
  override def listRequestParameters: Map[String, String] = Map()
}

63
case class CheckedListIdentifiersParameterExclusive (verb:OaiVerb, resumptionToken: ResumptionToken) extends OaiParameterBase {
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
  require(verb == ListIdentifiers)
  override def listRequestParameters: Map[String, String] = Map()
}

case class CheckedListMetadaFormatsParameter(verb:OaiVerb, identifier: Option[String]) extends OaiParameterBase {
  require(verb == ListMetadataFormats)
  override def listRequestParameters: Map[String, String] = Map()
}


final case class CheckedListRecordsParameter (verb:OaiVerb,
                                              metadataPrefix: String,
                                              from: Option[String],
                                              until: Option[String],
                                             set: Option[String]) extends OaiParameterBase {
  require(verb == ListRecords)
  override def listRequestParameters: Map[String, String] = Map()
}

83
final case class CheckedListRecordsParameterExclusive (verb:OaiVerb, resumptionToken: ResumptionToken) extends OaiParameterBase {
84
85
86
87
88
89
90
91
92
93
94
95
96
97
  require(verb == ListRecords)
  override def listRequestParameters: Map[String, String] = Map()
}

case class CheckedListSetsParameterExclusive (verb:OaiVerb, resumptionToken: String) extends OaiParameterBase {
  require(verb == ListSets)
  override def listRequestParameters: Map[String, String] = Map()
}

case class CheckedListSetsParameter (verb:OaiVerb) extends OaiParameterBase {
  require(verb == ListSets)
  override def listRequestParameters: Map[String, String] = Map()
}

98
case class BadArgumentsParameter (verb: OaiVerb ,badArguments: Map[String,String]) extends OaiParameterBase {
99
100
101
102
103

  //require on verb is not possible because could be any out of the Enums type
  override def listRequestParameters: Map[String, String] = Map()

}