diff --git a/server/repo/repository-api/src/main/java/org/eclipse/vorto/repository/api/IModelRepository.java b/server/repo/repository-api/src/main/java/org/eclipse/vorto/repository/api/IModelRepository.java index ad2acdf039..6d268c0010 100644 --- a/server/repo/repository-api/src/main/java/org/eclipse/vorto/repository/api/IModelRepository.java +++ b/server/repo/repository-api/src/main/java/org/eclipse/vorto/repository/api/IModelRepository.java @@ -52,7 +52,7 @@ public interface IModelRepository { /** * Creates a new model query builder as a helper for searching models via {@link IModelRepository#search(ModelQuery)} - * @return + * @return the model query builder */ static ModelQueryBuilder newQuery() { return new ModelQueryBuilder(); diff --git a/server/repo/repository-server/pom.xml b/server/repo/repository-server/pom.xml index c3b097f81a..3e7c459e72 100644 --- a/server/repo/repository-server/pom.xml +++ b/server/repo/repository-server/pom.xml @@ -219,6 +219,13 @@ + + + javax.interceptor + javax.interceptor-api + 3.1 + + diff --git a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/IModelParser.java b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/IModelParser.java index 99fb666e3a..788294e681 100644 --- a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/IModelParser.java +++ b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/IModelParser.java @@ -27,7 +27,7 @@ public interface IModelParser { /** * builds a model resource from the given inputstream * @param is the actual content containing model related meta data - * @return + * @return the Model information */ ModelInfo parse(InputStream is); } diff --git a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/ITemporaryStorage.java b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/ITemporaryStorage.java index 198aa2b2aa..f8a73fc96b 100644 --- a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/ITemporaryStorage.java +++ b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/ITemporaryStorage.java @@ -18,9 +18,10 @@ public interface ITemporaryStorage { /** * stores the given model content and returns a handleId - * @param content - * @param modelType - * @return + * @param key + * @param value + * @param timeToLiveSeconds + * @return the stored item */ StorageItem store(String key, Object value, long timeToLiveSeconds); diff --git a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/generation/IGeneratorLookupRepository.java b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/generation/IGeneratorLookupRepository.java index 0292fbbd83..d446ef0dea 100644 --- a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/generation/IGeneratorLookupRepository.java +++ b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/generation/IGeneratorLookupRepository.java @@ -27,14 +27,14 @@ public interface IGeneratorLookupRepository extends CrudRepository findByGeneratorKey(String generatorKey); /** * Finds all generators by either platform or documentation classifier * @param classifier - * @return + * @return list of generators */ List findByClassifier(String classifier); } diff --git a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/utils/ModelIdHelper.java b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/utils/ModelIdHelper.java index 44c2867be0..7e03c40cb4 100644 --- a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/utils/ModelIdHelper.java +++ b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/utils/ModelIdHelper.java @@ -39,7 +39,7 @@ public String getNamespacePath() { /** * Example path: /org/eclipse/vorto/color/1.0.0/ * @param path - * @return + * @return the model id */ public static ModelId fromPath(String path) { String[] pathFragments = path.substring(1).split("/"); diff --git a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/utils/ModelSearchUtil.java b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/utils/ModelSearchUtil.java index 29222aecba..b9fb89bf6f 100644 --- a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/utils/ModelSearchUtil.java +++ b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/internal/service/utils/ModelSearchUtil.java @@ -107,7 +107,7 @@ public ModelSearchUtil() { * applicable on this query. * * @param queryExpression - * @return {@link SearchStrategy} + * @return the search strategy to be used */ public SearchStrategy getSearchStrategy(String queryExpression) { searchCriteriaParameterMap.clear(); @@ -144,7 +144,7 @@ public SearchStrategy getSearchStrategy(String queryExpression) { * 'Color') * * @param queryExpression - * @return + * @return the query */ public String getJCRStatementQuery(String queryExpression) { if (getSearchStrategy(queryExpression) == SearchStrategy.FULL_TEXT) { @@ -195,7 +195,7 @@ private void addToSearchCriteriaParameterMap(String key, String value) { * This search query is built using the filters and their parameters * specified in the original query expression. * - * @return + * @return the string query */ private String buildJCRSearchQuery() { StringBuilder stringBuilder = new StringBuilder(); diff --git a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/model/IModelContent.java b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/model/IModelContent.java index 44a2bebbc1..473f443920 100644 --- a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/model/IModelContent.java +++ b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/model/IModelContent.java @@ -22,19 +22,19 @@ public interface IModelContent { /** * EMF Model object * - * @return + * @return the model */ Model getModel(); /** * format of the model content - * @return + * @return the type of the model */ ContentType getType(); /** * actual model content value - * @return + * @return the context of the model */ byte[] getContent(); } diff --git a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IGeneratorService.java b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IGeneratorService.java index bb5d449de9..5822a1f608 100644 --- a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IGeneratorService.java +++ b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IGeneratorService.java @@ -57,14 +57,14 @@ public interface IGeneratorService { /** * Gets more information about the generator, such as description, rating, creator etc. * @param serviceKey - * @return + * @return the generator info */ GeneratorInfo getGeneratorServiceInfo(String serviceKey); /** * Returns the mostly used generators * @param top the upper limit of results, e.g. top 3 or top 10 - * @return + * @return the list of generators */ Collection getMostlyUsedGenerators(int top); diff --git a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IModelRepository.java b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IModelRepository.java index 53ec764c4e..aee1d7265b 100644 --- a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IModelRepository.java +++ b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IModelRepository.java @@ -32,29 +32,29 @@ public interface IModelRepository { /** * Searches model resources for the given expression * @param queryExpression - * @return + * @return the list of models */ List search(String queryExpression); /** * Gets a model resource for the given model id * @param modelId - * @return + * @return the model information */ ModelInfo getById(ModelId modelId); /** * Returns the actual model content for the given model id * @param modelId - * @param content type + * @param contentType * @throws ModelNotFoundException - * @return + * @return the model content */ IModelContent getModelContent(ModelId modelId, ContentType contentType); /** * Uploads model content and validates it. If the model is valid, the returned upload handle is used - * to checkin the model into the repository via {@link IModelRepository#checkin(String)}} + * to checkin the model into the repository via {@link IModelRepository#checkin(String, String)}} * * @param content to validate * @param fileName @@ -63,12 +63,10 @@ public interface IModelRepository { UploadModelResult upload(byte[] content, String fileName); /** - * @pre {@link UploadModelResult#isValid() == true}} - * - * @post model was stored in persistence layer. Notifications were sent out to watchers. + * model was stored in persistence layer. Notifications were sent out to watchers. * * Checks in a new model into the repository - * @param uploadHandle + * @param handleId * @param author */ void checkin(String handleId, String author); @@ -83,7 +81,7 @@ public interface IModelRepository { /** * * @param modelId - * @return + * @return the model image */ byte[] getModelImage(ModelId modelId); @@ -91,7 +89,7 @@ public interface IModelRepository { * Gets all mapping model resources for the given modelId * @param modelId * @param targetPlatform - * @return + * @return the list of models */ List getMappingModelsForTargetPlatform(ModelId modelId, String targetPlatform); diff --git a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IRepositoryManager.java b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IRepositoryManager.java index 842343cba2..b2a00ed3b1 100644 --- a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IRepositoryManager.java +++ b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IRepositoryManager.java @@ -22,14 +22,14 @@ public interface IRepositoryManager { /** * creates a complete backup of the repository content - * @return + * @return the backup contents * @throws Exception */ byte[] backup() throws Exception; /** * restores the given backup. Previous data will be lost!! - * @param inputStream + * @param backup * @throws Exception */ void restore(byte[] backup) throws Exception; diff --git a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IUserRepository.java b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IUserRepository.java index b10baa827b..bb7750d3ca 100644 --- a/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IUserRepository.java +++ b/server/repo/repository-server/src/main/java/org/eclipse/vorto/repository/service/IUserRepository.java @@ -24,14 +24,14 @@ public interface IUserRepository extends CrudRepository { /** * finds the user by the specified email address * @param email - * @return + * @return the user */ User findByEmail(String email); /** * Finds the user by the specified username * @param username - * @return + * @return the user */ User findByUsername(String username); } \ No newline at end of file