001/* 002 * (C) Copyright 2018 Nuxeo (http://nuxeo.com/) and others. 003 * 004 * Licensed under the Apache License, Version 2.0 (the "License"); 005 * you may not use this file except in compliance with the License. 006 * You may obtain a copy of the License at 007 * 008 * http://www.apache.org/licenses/LICENSE-2.0 009 * 010 * Unless required by applicable law or agreed to in writing, software 011 * distributed under the License is distributed on an "AS IS" BASIS, 012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 013 * See the License for the specific language governing permissions and 014 * limitations under the License. 015 * 016 * Contributors: 017 * Thomas Roger 018 */ 019 020package org.nuxeo.wopi; 021 022import org.nuxeo.ecm.core.api.Blob; 023 024/** 025 * WOPI Service. 026 * 027 * @since 10.3 028 */ 029public interface WOPIService { 030 031 /** 032 * Returns @{code true} if WOPI is enabled, {@code false} otherwise. 033 * <p> 034 * The WOPI discovery XML file has been loaded. 035 */ 036 boolean isEnabled(); 037 038 /** 039 * Returns a {@link WOPIBlobInfo} for the given blob if it is supported by WOPI, {@code null} otherwise. 040 */ 041 WOPIBlobInfo getWOPIBlobInfo(Blob blob); 042 043 /** 044 * Returns the WOPI action url given a {@code blob} and an {@code action}. 045 */ 046 String getActionURL(Blob blob, String action); 047 048 /** 049 * Verifies that the request originate from Office Online. 050 */ 051 boolean verifyProofKey(String proofKeyHeader, String oldProofKeyHeader, String url, String accessToken, 052 String timestampHeader); 053 054 /** 055 * Refreshes the WOPI discovery: fetches the data from the discovery URL, stores it and loads it in memory. 056 * 057 * @return {@code true} if refreshing the discovery has succeeded, {@code false} otherwise 058 * @since 10.10 059 */ 060 boolean refreshDiscovery(); 061 062}