Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Separate SWORD protocol from Fedora provider code
- Loading branch information
Showing
7 changed files
with
162 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
src/main/java/org/fcrepo/sword/protocol/SWORDProtocol.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| /** | ||
| * Copyright 2015 DuraSpace, Inc. | ||
| * | ||
| * 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.fcrepo.sword.protocol; | ||
|
|
||
| /** | ||
| * Defines SWORD protocol related namespaces and constants | ||
| * | ||
| * @author claussni | ||
| */ | ||
| public class SWORDProtocol { | ||
| public static final String SWORD_NAMESPACE = "http://purl.org/net/sword/"; | ||
| public static final String SWORD_TERMS_NAMESPACE = "http://purl.org/net/sword/terms/"; | ||
| public static final String SWORD_VERSION = "2.0"; | ||
|
|
||
| private SWORDProtocol() { | ||
| // Utility classes should not have a public or default constructor. | ||
| } | ||
| } |
107 changes: 107 additions & 0 deletions
107
src/main/java/org/fcrepo/sword/protocol/SWORDServiceDocumentBuilder.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /** | ||
| * Copyright 2015 DuraSpace, Inc. | ||
| * | ||
| * 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.fcrepo.sword.protocol; | ||
|
|
||
| import org.apache.abdera.Abdera; | ||
| import org.apache.abdera.model.Service; | ||
| import org.fcrepo.kernel.api.models.Container; | ||
| import org.fcrepo.kernel.api.models.FedoraResource; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import javax.jcr.RepositoryException; | ||
| import javax.jcr.Value; | ||
|
|
||
| import static org.fcrepo.sword.protocol.SWORDProtocol.SWORD_TERMS_NAMESPACE; | ||
| import static org.fcrepo.sword.protocol.SWORDProtocol.SWORD_VERSION; | ||
|
|
||
| /** | ||
| * Builder for a SWORD service document using Abdera ATOM library | ||
| * | ||
| * @author claussni | ||
| */ | ||
| public class SWORDServiceDocumentBuilder { | ||
|
|
||
| private Abdera abdera; | ||
| private Integer maxUploadSize; | ||
| private Container workspaces; | ||
| private Logger log; | ||
|
|
||
| /** | ||
| * Create a new builder | ||
| * | ||
| * @param abdera Abdera implementation to use | ||
| * @param log Logger implementation to use. If none is given, a default logger for this class is used. | ||
| */ | ||
| public SWORDServiceDocumentBuilder(final Abdera abdera, final Logger log) { | ||
| this.abdera = abdera; | ||
| this.log = (log == null) ? LoggerFactory.getLogger(SWORDServiceDocumentBuilder.class) : log; | ||
| } | ||
|
|
||
| /** | ||
| * Set the maxUploadSize parameter | ||
| * | ||
| * @param swordMaxUploadSizeKb Maximum size of uploads in kilobytes | ||
| * @return The builder object | ||
| */ | ||
| public SWORDServiceDocumentBuilder maxUploadSize(final Integer swordMaxUploadSizeKb) { | ||
| this.maxUploadSize = swordMaxUploadSizeKb; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Set the Fedora container resource containing the SWORD workspace nodes | ||
| * | ||
| * @param workspaces Container with workspace nodes | ||
| * @return The builder object | ||
| */ | ||
| public SWORDServiceDocumentBuilder workspacesContainer(final Container workspaces) { | ||
| this.workspaces = workspaces; | ||
| return this; | ||
| } | ||
|
|
||
| /** | ||
| * Build and return the service document containing the configured parameters and detected workspaces | ||
| * | ||
| * @return A SWORD service document | ||
| */ | ||
| public Service serviceDocument() { | ||
| final Service service = abdera.newService(); | ||
| service.addSimpleExtension(SWORD_TERMS_NAMESPACE, "version", "sword", SWORD_VERSION); | ||
| service.addSimpleExtension(SWORD_TERMS_NAMESPACE, "maxUploadSize", "sword", String.valueOf(maxUploadSize)); | ||
| workspaces.getChildren().forEachRemaining(fedoraResource -> addWorkspace(service, fedoraResource)); | ||
| return service; | ||
| } | ||
|
|
||
| private void addWorkspace(final Service service, final FedoraResource fedoraResource) { | ||
| try { | ||
| final Value[] dcTitles = fedoraResource.getProperty("dc:title").getValues(); | ||
| if (dcTitles.length > 0) { | ||
| try { | ||
| final String title = dcTitles[0].getString(); | ||
| if (!title.isEmpty()) { | ||
| service.addWorkspace(title); | ||
| } | ||
| } catch (IndexOutOfBoundsException | NullPointerException e) { | ||
| log.warn("Found workspace container without dc:title property: {}", fedoraResource.getPath()); | ||
| } | ||
| } | ||
| } catch (RepositoryException e) { | ||
| log.warn("Found workspace container with invalid dc:title property: {}", fedoraResource.getPath()); | ||
| } | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters