refactor: Update paramter and and javadoc

M3lkior · Nov 23, 2015 · dacd34d · dacd34d
1 parent 5a9390e
commit dacd34d
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 25 deletions.
diff --git a/src/main/java/io/gravitee/repository/management/api/ApiKeyRepository.java b/src/main/java/io/gravitee/repository/management/api/ApiKeyRepository.java
@@ -39,11 +39,11 @@ public interface ApiKeyRepository {
 	/**
 	 * Create a new API Key for an {@link Application} and an {@link Api}
 	 *
-	 * @param applicationName Application name
-	 * @param apiName Name of the Api to associate
+	 * @param applicationId Application ID
+	 * @param apiId ID of the Api to associate
 	 * @return Newly created API Key
 	 */
-	ApiKey create(String applicationName, String apiName, ApiKey key) throws TechnicalException;
+	ApiKey create(String applicationId, String apiId, ApiKey key) throws TechnicalException;
 
 	/**
 	 * Update an API Key
@@ -56,28 +56,28 @@ public interface ApiKeyRepository {
 	/**
 	 * Provide an history of all API Keys generated for an {@link Application} and an {@link Api}
 	 *
-	 * @param applicationName Application name
-	 * @param apiName Name of the Api
+	 * @param applicationId Application ID
+	 * @param apiId ID of the Api
 	 * @return List of generated keys for an {@link Application} and an {@link Api}
 	 * @throws TechnicalException
 	 */
-	Set<ApiKey> findByApplicationAndApi(String applicationName, String apiName) throws TechnicalException;
+	Set<ApiKey> findByApplicationAndApi(String applicationId, String apiId) throws TechnicalException;
 
 	/**
 	 * Provide Api Keys for a given application
 	 * 
-	 * @param applicationName
+	 * @param applicationId
 	 * @return
 	 * @throws TechnicalException
 	 */
-	Set<ApiKey> findByApplication(String applicationName) throws TechnicalException;
+	Set<ApiKey> findByApplication(String applicationId) throws TechnicalException;
 
 	/**
 	 * Provide Api Keys for a given API
 	 *
-	 * @param apiName
+	 * @param apiId
 	 * @return
 	 * @throws TechnicalException
 	 */
-	Set<ApiKey> findByApi(String apiName) throws TechnicalException;
+	Set<ApiKey> findByApi(String apiId) throws TechnicalException;
 }
diff --git a/src/main/java/io/gravitee/repository/management/api/ApiRepository.java b/src/main/java/io/gravitee/repository/management/api/ApiRepository.java
@@ -57,16 +57,16 @@ public interface ApiRepository extends CrudRepository<Api, String>{
     /**
      * Find APIs associated with an application
      *
-     * @param application Application Name
+     * @param applicationId Application ID
      * @return Apis associated
      */
-    Set<Api> findByApplication(String application) throws TechnicalException;
+    Set<Api> findByApplication(String applicationId) throws TechnicalException;
 
-    void saveMember(String api, String username, MembershipType membershipType) throws TechnicalException;
+    void saveMember(String apiId, String username, MembershipType membershipType) throws TechnicalException;
 
-    void deleteMember(String api, String username) throws TechnicalException;
+    void deleteMember(String apiId, String username) throws TechnicalException;
 
-    Collection<Membership> getMembers(String api, MembershipType membershipType) throws TechnicalException;
+    Collection<Membership> getMembers(String apiId, MembershipType membershipType) throws TechnicalException;
 
-    Membership getMember(String api, String username) throws TechnicalException;
+    Membership getMember(String apiId, String username) throws TechnicalException;
 }
diff --git a/src/main/java/io/gravitee/repository/management/api/ApplicationRepository.java b/src/main/java/io/gravitee/repository/management/api/ApplicationRepository.java
@@ -44,16 +44,16 @@ public interface ApplicationRepository extends CrudRepository<Application, Strin
     /**
      * Count {@link Application} owner by a given {@link User}
      *
-     * @param userName Application user owner name
+     * @param username Application user owner name
      * @return Counted application
      */
-    int countByUser(String userName, MembershipType membershipType) throws TechnicalException;
+    int countByUser(String username, MembershipType membershipType) throws TechnicalException;
 
-    void saveMember(String application, String username, MembershipType membershipType) throws TechnicalException;
+    void saveMember(String applicationId, String username, MembershipType membershipType) throws TechnicalException;
 
-    void deleteMember(String application, String username) throws TechnicalException;
+    void deleteMember(String applicationId, String username) throws TechnicalException;
 
-    Collection<Membership> getMembers(String application, MembershipType membershipType) throws TechnicalException;
+    Collection<Membership> getMembers(String applicationId, MembershipType membershipType) throws TechnicalException;
 
-    Membership getMember(String application, String username) throws TechnicalException;
+    Membership getMember(String applicationId, String username) throws TechnicalException;
 }
diff --git a/src/main/java/io/gravitee/repository/management/api/PageRepository.java b/src/main/java/io/gravitee/repository/management/api/PageRepository.java
@@ -25,9 +25,9 @@
  */
 public interface PageRepository extends CrudRepository<Page, String> {
 
-	Collection<Page> findPublishedByApi(String apiName) throws TechnicalException;
+	Collection<Page> findPublishedByApi(String apiId) throws TechnicalException;
 
-	Collection<Page> findByApi(String apiName) throws TechnicalException;
+	Collection<Page> findByApi(String apiId) throws TechnicalException;
 
-	Integer findMaxPageOrderByApiName(String apiName) throws TechnicalException;
+	Integer findMaxPageOrderByApi(String apiId) throws TechnicalException;
 }