diff --git a/backend-java-api/allclasses-index.html b/backend-java-api/allclasses-index.html new file mode 100644 index 000000000..79cfb67ac --- /dev/null +++ b/backend-java-api/allclasses-index.html @@ -0,0 +1,555 @@ + + + + +All Classes and Interfaces + + + + + + + + + + + + + + + +
+ +
+
+
+

All Classes and Interfaces

+
+
+
+
+
+
Class
+
Description
+
AccountTakenException
+
+
This exception is thrown when the email-address, used to register a user, has already been assigned to an account.
+
+
AddToStudentUnitTests
+
+
Unit tests for testing whether answers to the form are correctly to a student.
+
+
AdminAssignmentEndpointTests
+
+
Class testing the integration of Assignment with an admin access level.
+
+
AdminCommunicationEndpointTests
+
+
Class testing the integration of Communication with admin privileges.
+
+
AdminCommunicationTemplateEndpointTests
+
+
Class testing the integration of CommunicationTemplate with admin privileges.
+
+
AdminEditionEndpointTests
+
+
Class testing the integration of Edition as an admin.
+
+
AdminEndpointTest<T,I extends Serializable,R extends org.springframework.data.jpa.repository.JpaRepository<T,I>>
+
+
Abstract class to help with testing the integration of endpoints.
+
+
AdminInvitationEndpointTests
+
+
Class testing the integration of Invitation with admin privileges.
+
+
AdminProjectEndpointTests
+
+
Class testing the integration of Project with an admin access level.
+
+
AdminProjectSkillEndpointTests
+
+
Class testing the integration of ProjectSkill with an admin access level.
+
+
AdminSkillTypeEndpointTests
+
+
Class testing the integration of SkillType for an Admin.
+
+
AdminStudentEndpointTests
+
+
Class testing the integration of Student as an admin.
+
+
AdminSuggestionEndpointTests
+
+
Class testing the integration of Suggestion.
+
+
AdminUserEndpointTests
+
+
Class testing the integration of UserEntity as an admin.
+
+
AdminUserSkillEndpointTests
+
+
Class testing the integration of UserSkill as an admin.
+
+
Assignment
+
+
The database entity for an Assignment.
+
+
AssignmentDTO
+
+
A DTO that helps to convert a Assignment to its JSON representation.
+
+
AssignmentRepository
+
+
This is a simple class that defines a repository for Assignment, + this is needed for the database.
+
+
AuthenticationTest
+
+
Class testing the authentication in spring.
+
+
BaseAdminCreatedTest
+
+
Class used to test whether the base admin user gets created on startup when there are no enabled admins.
+
+
BaseAdminResetTest
+
+
Class used to test whether the base admin user gets reset on startup when there are no enabled admins.
+
+
BaseAdminTestConfig
+
+
Test configuration to initialize the base admin user.
+
+
BaseTestPerformer<T,I extends Serializable,R extends org.springframework.data.jpa.repository.JpaRepository<T,I>>
+
+
Abstract class to help with testing the integration of endpoints.
+
+
CoachAssignmentEndpointTests
+
+
Class testing the integration of Assignment for a coach.
+
+
CoachCommunicationEndpointTests
+
+
Class testing the integration of Communication for a coach.
+
+
CoachCommunicationTemplateEndpointTests
+
+
Class testing the integration of CommunicationTemplate for a coach.
+
+
CoachEditionEndpointTests
+
+
Class testing the integration of Edition for a coach.
+
+
CoachInvitationEndpointTests
+
+
Class testing the integration of Invitation for a coach.
+
+
CoachProjectEndpointTests
+
+
Class testing the integration of Project with an coach access level.
+
+
CoachProjectSkillEndpointTests
+
+
Class testing the integration of ProjectSkill with a coach access level.
+
+
CoachSkillTypeEndpointTests
+
+
Class testing the integration of SkillType for a coach.
+
+
CoachStudentEndpointTests
+
+
Class testing the integration of Student for a coach.
+
+
CoachSuggestionEndpointTests
+
+
Class testing the integration of Suggestion for a coach.
+
+
CoachUserEndpointTests
+
+
Class testing the integration of UserEntity as a coach.
+
+
CoachUserSkillEndpointTests
+
+
Class testing the integration of UserSkill as a coach.
+
+
Communication
+
+
The database entity for Communication.
+
+
CommunicationDTO
+
+
A DTO that helps to convert a Communication to its JSON representation.
+
+
CommunicationRepository
+
+
This is a simple class that defines a repository for Communication, + this is needed for the database.
+
+
CommunicationTemplate
+
+
The database entity for a CommunicationTemplate.
+
+
CommunicationTemplateRepository
+
+
This is a simple class that defines a repository for CommunicationTemplate, + this is needed for the database.
+
+
ConversionExceptionAdvice
+
+
This class makes it so that when an bad request is returned when conversion fails.
+
+
DevelopmentUsesHttpTest
+
+
This test is used to check that the application uses http communication when in the development profile.
+
+
DumbledorePathWizard
+
+
The DumbledorePathWizard is a wizard that helps us in the noble quest to not use paths ourselves.
+
+
Edition
+
+
The database entity for an Edition.
+
+
EditionRepository
+
+
This is a simple class that defines a repository for Edition, + this is needed for the database.
+
+
EmailService
+
+
This component is used for sending emails from the mail account configured in application.properties.
+
+
EnglishProficiency
+
+
An enum listing the different kinds of English proficiency a Student can have.
+
+
FieldType
+
+
A field type represents the type of a question field.
+
+
ForgotPasswordController
+
+
This controller is used to handle the forgot and reset password process.
+
+
ForgotPasswordTest
+
+
Class testing the forgot and reset password process.
+
+
FormField
+
+
A form field represents a single question from the tally form.
+
+
FormFieldUnitTests
+
+
Unit tests for testing the auxiliary methods of the FormField class.
+
+
FormProcessor
+
+
This class is used to process forms received from the webhook.
+
+
Gender
+
+
An enum listing the different kinds of genders a Student can have.
+
+
GlobalStatusCodeAdviser
+
+
Class that provides default messages for status codes.
+
+
InvalidInvitationTokenException
+
+
This custom exception is thrown when an invalid invitation token is used when attempting to register a new user.
+
+
InvalidResetPasswordTokenException
+
+
This custom exception is thrown when an invalid reset password token is used when attempting to reset a password.
+
+
Invitation
+
+
The database entity for an Invitation.
+
+
InvitationDTO
+
+
A DTO that helps to convert a Invitation to its JSON representation.
+
+
InvitationRepository
+
+
This is a simple class that defines a repository for Invitation.
+
+
MeguminExceptionWizard
+
+
MeguminExceptionWizard is a wizard that helps us remember Exception messages.
+
+
MerlinSpELWizard
+
+
Merlin is a SpEL (Spring Expression Language) Wizard.
+
+
Option
+
+
An option is used when the user can select multiple possible answers to a question.
+
+
Osoc6Application
+
+
Auto generated Spring boot application.
+
+
Osoc6ApplicationTests
+
+
Auto generated class that tests if the context can be loaded.
+
+
OsocExperience
+
+
This enum contains the different kinds of experience a student can have in OSOC.
+
+
PasswordEncoder
+
+
This encoder is used to encode the passwords for the users.
+
+
ProductionUsesHttpsTest
+
+
This test is used to check that the application uses https communication when in the production profile.
+
+
Project
+
+
The database entity for a project.
+
+
ProjectDTO
+
+
A DTO that helps to convert a Project to its JSON representation.
+
+
ProjectRepository
+
+
This is a simple class that defines a repository for Project.
+
+
ProjectSkill
+
+
The database entity for a skill looked for in a Project.
+
+
ProjectSkillDTO
+
+
A DTO that helps to convert a ProjectSkill to its JSON representation.
+
+
ProjectSkillRepository
+
+
This is a simple class that defines a repository for ProjectSkill, + this is needed for the database.
+
+
PublicRepository
+
+
This is our custom repository.
+
+
QuestionKey
+
+
This enum holds all questions used to fill in a new Student.
+
+
RadagastNumberWizard
+
+
The RadagastNumberWizard is a wizard that helps us in the noble quest to not use Magic numbers ourselves.
+
+
RegistrationController
+
+
This controller handles the mappings for the registration of a user.
+
+
RegistrationDTO
+
+
DTO for registrations containing the information needed to set up a user.
+
+
RegistrationExceptionAdvice
+
+
This class handles exceptions related to the registration process.
+
+
RegistrationService
+
+
This service handles the registration of a user.
+
+
ResetPasswordExceptionAdvice
+
+
This class handles exceptions related to the reset password process.
+
+
ResetPasswordToken
+
+
The database entity for a ResetPasswordToken.
+
+
ResetPasswordTokenRepository
+
+
This repository is used to access ResetPasswordToken in the database.
+
+
SecurityConfiguration
+
+
This class sets up the configuration to handle the authentication process.
+
+
SkillType
+
+
The database entity for a SkillType.
+
+
SkillTypeRepository
+
+
This is a simple class that defines a repository for SkillType, + this is needed for the database.
+
+
SpelUtil
+
+
This class helps with authorization.
+
+
Status
+
+
This enum contains the different status a student can have.
+
+
Student
+
+
The database entity for a Student.
+
+
StudentDTO
+
+
A DTO that helps to convert a student to its JSON representation.
+
+
StudentRepository
+
+
This is a simple class that defines a repository for Student, + this is needed for the database.
+
+
Suggestion
+
+
The database entity for a Suggestion.
+
+
SuggestionDTO
+
+
A DTO that helps to convert a Suggestion to its JSON representation.
+
+
SuggestionRepository
+
+
This is a simple class that defines a repository for Suggestion, + this is needed for the database.
+
+
SuggestionStrategy
+
+
Different methods to make a suggestion about a user.
+
+
TestEntityProvider
+
+
This class provides some entities to classes.
+
+
TestFunctionProvider<T,I extends Serializable,R extends org.springframework.data.jpa.repository.JpaRepository<T,I>>
+
+
Abstract class to help with testing the integration of endpoints.
+
+
UserDTO
+
+
A DTO that helps to convert a student to its JSON representation.
+
+
UserEntity
+
+
The database entity for a User.
+
+
UserEntityEventHandler
+
+
This class can be used to add functionality before certain events related to the UserEntity.
+
+
UserEntityService
+
+
This service handles user functionalities such as finding and registering a user.
+
+
UserRepository
+
+
This is a simple class that defines a repository for UserEntity.
+
+
UserRole
+
+
This enum represents the different technical roles a user can have within the application.
+
+
UserSkill
+
+
The database entity for a skill of a UserEntity.
+
+
UserSkillDTO
+
+
A DTO that helps to convert a UserSkill to its JSON representation.
+
+
UserSkillRepository
+
+
This is a simple class that defines a repository for UserSkill, + this is needed for the database.
+
+
Util
+
+
Util is a class that offers some test utility functions.
+
+
ValidationExceptionAdvice
+
+
Advice used to handle all exceptions thrown by validating user input.
+
+
VengerbergMailWizard
+
+
The VengerbergMailWizard that helps us with all email related Strings.
+
+
WeakToEdition
+
+
This interface expresses weakness to edition and allows us to find the edition an instance is weak to.
+
+
WebConfiguration
+
+
The configuration of the application.
+
+
WebhookController
+
+
This controller is the webhook used to automatically process tally forms.
+
+
WebhookData
+
+
Data class containing the metadata and user submitted data of the tally webhook.
+
+
WebhookEndpointTests
+
+
Class testing the integration of the webhook.
+
+
WebhookException
+
+
This exception is thrown when there is a problem while parsing the data from the tally webhook.
+
+
WebhookExceptionAdvice
+
+
This class handles exceptions related to the webhook form processing.
+
+
WebhookForm
+
+
Data class containing the json received from the tally webhook.
+
+
WebhookService
+
+
This service handles the processing of the webhook form.
+
+
+
+
+
+
+
+ + diff --git a/documentation/backend/allpackages-index.html b/backend-java-api/allpackages-index.html similarity index 77% rename from documentation/backend/allpackages-index.html rename to backend-java-api/allpackages-index.html index 1994ee174..ee63a59dd 100644 --- a/documentation/backend/allpackages-index.html +++ b/backend-java-api/allpackages-index.html @@ -1,7 +1,7 @@ - + - + All Packages @@ -58,10 +58,26 @@

All Packages

This module is the main entry point to the application.
-
com.osoc6.OSOC6.configuration
+
com.osoc6.OSOC6.adminTest
+
This module contains all tests that test with access level admin.
+
+
com.osoc6.OSOC6.anonymousTest
+
+
This module contains all tests that run without authentication.
+
+
com.osoc6.OSOC6.coachTest
+
+
This module contains all tests that test with access level coach.
+
+
com.osoc6.OSOC6.configuration
+
This module contains the configuration related classes.
+
com.osoc6.OSOC6.configurationTest
+
+
This package contains all tests for checking whether the configuration of the application works correctly.
+
com.osoc6.OSOC6.controller
This package contains all controllers used for the API.
@@ -106,8 +122,12 @@

All Packages

This package contains all classes used for processing the received tally submissions.
-
com.osoc6.OSOC6.winterhold
+
com.osoc6.OSOC6.webhookTest
+
Module containing all tests related to the webhook.
+
+
com.osoc6.OSOC6.winterhold
+
This package contains all wizards.
diff --git a/backend-java-api/com/osoc6/OSOC6/BaseTestPerformer.html b/backend-java-api/com/osoc6/OSOC6/BaseTestPerformer.html new file mode 100644 index 000000000..7c0a944a5 --- /dev/null +++ b/backend-java-api/com/osoc6/OSOC6/BaseTestPerformer.html @@ -0,0 +1,943 @@ + + + + +BaseTestPerformer + + + + + + + + + + + + + + + +
+ +
+
+ +
+
Package com.osoc6.OSOC6
+

Class BaseTestPerformer<T,I extends Serializable,R extends org.springframework.data.jpa.repository.JpaRepository<T,I>>

+
+
java.lang.Object +
com.osoc6.OSOC6.BaseTestPerformer<T,I,R>
+
+
+
+
Type Parameters:
+
T - the entity of the repository using this class
+
I - the id type of the entity
+
R - the repository linked to the entity
+
+
+
Direct Known Subclasses:
+
TestFunctionProvider, WebhookEndpointTests
+
+
+
@ActiveProfiles("test") +public abstract class BaseTestPerformer<T,I extends Serializable,R extends org.springframework.data.jpa.repository.JpaRepository<T,I>> +extends Object
+
Abstract class to help with testing the integration of endpoints. + Implements basic functions to be used when creating endpoint tests. + Provides an edition, coachUser, adminUser and invitation when + base setup and base removed are called in the setup and remove functions. + + The ActiveProfiles annotation indicates that everything this class + and it's subclasses do should be run with the test profile.
+
+
+ +
+
+
    + +
  • +
    +

    Field Details

    +
      +
    • +
      +

      mockMvc

      +
      @Autowired +private org.springframework.test.web.servlet.MockMvc mockMvc
      +
      This mocks the server without starting it.
      +
      +
      • +
    • +
      +

      editionRepository

      +
      @Autowired +private EditionRepository editionRepository
      +
      The edition repository which saves, searches, ... Editions in the database
      +
      +
      • +
    • +
      +

      userRepository

      +
      @Autowired +private UserRepository userRepository
      +
      The user repository which saves, searches, ... UserEntities in the database
      +
      +
      • +
    • +
      +

      invitationRepository

      +
      @Autowired +private InvitationRepository invitationRepository
      +
      The invitation repository which saves, searches, ... Invitations in the database
      +
      +
      • +
    • +
      +

      baseActiveUserEdition

      +
      private final Edition baseActiveUserEdition
      +
      The acitve test edition. Used so that our test users can be linked to an edition.
      +
      +
      • +
    • +
      +

      baseNonActiveUserEdition

      +
      private final Edition baseNonActiveUserEdition
      +
      The non-active test edition. Used so we test non-active edition interactions.
      +
      +
      • +
    • +
      +

      ADMIN_EMAIL

      +
      protected static final String ADMIN_EMAIL
      +
      Email of the admin as a static final field. This way it can be used within annotations.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      COACH_EMAIL

      +
      protected static final String COACH_EMAIL
      +
      Email of the coach as a static final field. This way it can be used within annotations.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      OUTSIDER_EMAIL

      +
      public static final String OUTSIDER_EMAIL
      +
      Email of the outsider coach as a static final field. This way it can be used within annotations.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      MATCHING_EMAIL

      +
      public static final String MATCHING_EMAIL
      +
      Email of the matching edition coach as a static final field. This way it can be used within annotations.
      +
      +
      See Also:
      +
      + +
      +
      +
      +
      • +
    • +
      +

      adminUser

      +
      private final UserEntity adminUser
      +
      The admin test user. This is the admin user that will be used to execute the tests.
      +
      +
      • +
    • +
      +

      coachUser

      +
      private final UserEntity coachUser
      +
      The coach sample user that gets loaded before every test.
      +
      +
      • +
    • +
      +

      matchingEditionCoach

      +
      private final UserEntity matchingEditionCoach
      +
      Sample User with a matching edition to base Coach that gets loaded before every test.
      +
      +
      • +
    • +
      +

      outsiderCoach

      +
      private final UserEntity outsiderCoach
      +
      The outsider coach sample user that gets loaded before every test.
      +
      +
      • +
    • +
      +

      invitationActiveEditionForCoach

      +
      private final Invitation invitationActiveEditionForCoach
      +
      The invitation for the coach user on the active edition. Makes it so the user is linked to the active edition.
      +
      +
      • +
    • +
      +

      invitationNonActiveEditionForCoach

      +
      private final Invitation invitationNonActiveEditionForCoach
      +
      The invitation for the coach user on the non-active edition. + Makes it so the user is linked to the non-active edition.
      +
      +
      • +
    • +
      +

      matchingEditionUserInvitation

      +
      private final Invitation matchingEditionUserInvitation
      +
      Invitation that makes matchingEditionCoach registered to the same edition as the base coach.
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Constructor Details

    +
      +
    • +
      +

      BaseTestPerformer

      +
      public BaseTestPerformer()
      +
      +
      • +
    +
    +
    • + +
  • +
    +

    Method Details

    +
      +
    • +
      +

      setupBasicData

      +
      public void setupBasicData()
      +
      Load the needed editions, users and invitations.
      +
      +
      • +
    • +
      +

      removeBasicData

      +
      public void removeBasicData()
      +
      Remove the editions, users and invitations.
      +
      +
      • +
    • +
      +

      get_id

      +
      public abstract I get_id(T entity)
      +
      Get the id from an entity, this can be used for multiple purposes.
      +
      +
      Parameters:
      +
      entity - entity whose id we would like to know
      +
      Returns:
      +
      the id of the entity
      +
      +
      +
      • +
    • +
      +

      get_repository

      +
      public abstract R get_repository()
      +
      Get the repository connected to entity T.
      +
      +
      Returns:
      +
      a repository from entity T
      +
      +
      +
      • +
    • +
      +

      setUpRepository

      +
      public abstract void setUpRepository()
      +
      +
      • +
    • +
      +

      removeSetUpRepository

      +
      public abstract void removeSetUpRepository()
      +
      +
      • +
    • +
      +

      performAsAdmin

      +
      protected void performAsAdmin(Runnable lambda)
      +
      Execute the given lambda with admin authorization.
      +
      +
      Parameters:
      +
      lambda - the lambda to execute
      +
      +
      +
      • +
    • +
      +

      setUp

      +
      @BeforeEach +public void setUp()
      +
      Set up the repository, with admin authority.
      +
      +
      • +
    • +
      +

      removeSetUp

      +
      @AfterEach +public void removeSetUp()
      +
      Remove the setup from the repository, with admin authority.
      +
      +
      • +
    • +
      +

      transform_to_json

      +
      public String transform_to_json(T entity)
      +
      Transform the entity to a JSON object. + A super class can override this function to alter the JSON format of the entity.
      +
      +
      Parameters:
      +
      entity - entity to transform
      +
      Returns:
      +
      the JSON object
      +
      +
      +
      • +
    • +
      +

      perform_post

      +
      public org.springframework.test.web.servlet.ResultActions perform_post(String path, + T entity) + throws Exception
      +
      Perform a POST request.
      +
      +
      Parameters:
      +
      path - The path the entity is served on, with '/' as prefix
      +
      entity - The entity we want to post
      +
      Returns:
      +
      a result action that can be used for more checks
      +
      Throws:
      +
      Exception - throws exception if the request or a check fails
      +
      +
      +
      • +
    • +
      +

      perform_get

      +
      public org.springframework.test.web.servlet.ResultActions perform_get(String path) + throws Exception
      +
      Perform a GET request.
      +
      +
      Parameters:
      +
      path - the path the resource is served on, with '/' as prefix
      +
      Returns:
      +
      a result action that can be used for more checks
      +
      Throws:
      +
      Exception - throws exception if the request or a check fails
      +
      +
      +
      • +
    • +
      +

      perform_queried_get

      +
      public org.springframework.test.web.servlet.ResultActions perform_queried_get(String path, + String[] paramNames, + String[] values) + throws Exception
      +
      Perform a get with queries.
      +
      +
      Parameters:
      +
      path - the path the resource is served on, with '/' as prefix
      +
      paramNames - the names of the parameters
      +
      values - the value of the parameters (same order as paramNames)
      +
      Returns:
      +
      a result action that can be used for more checks
      +
      Throws:
      +
      Exception - if the request or a check fails
      +
      +
      +
      • +
    • +
      +

      check_get

      +
      public org.springframework.test.web.servlet.ResultActions check_get(String path, + String check) + throws Exception
      +
      Perform a GET request that checks whether the entity is in the database.
      +
      +
      Parameters:
      +
      path - the path the entity is served on, with '/' as prefix
      +
      check - result matchers used to perform checks on the request
      +
      Returns:
      +
      a result action that can be used for more checks
      +
      Throws:
      +
      Exception - throws exception if the request or a check fails
      +
      +
      +
      • +
    • +
      +

      perform_delete_with_id

      +
      public org.springframework.test.web.servlet.ResultActions perform_delete_with_id(String path, + I id) + throws Exception
      +
      Perform a DELETE request.
      +
      +
      Parameters:
      +
      path - the path the entity is served on, with '/' as prefix
      +
      id - the id of the entity we want to remove
      +
      Returns:
      +
      a result action that can be used for more checks
      +
      Throws:
      +
      Exception - throws exception if the request or a check fails
      +
      +
      +
      • +
    • +
      +

      perform_patch

      +
      public org.springframework.test.web.servlet.ResultActions perform_patch(String path, + String patchBody) + throws Exception
      +
      Perform a PATCH request with select content.
      +
      +
      Parameters:
      +
      path - The path the entity is served on, with '/' as prefix
      +
      patchBody - The body of the patch request
      +
      Returns:
      +
      a result action that can be used for more checks
      +
      Throws:
      +
      Exception - throws exception if the request or a check fails
      +
      +
      +
      • +
    • +
      +

      perform_patch

      +
      public org.springframework.test.web.servlet.ResultActions perform_patch(String path, + Map<String,String> map) + throws Exception
      +
      Perform a PATCH request with select fields.
      +
      +
      Parameters:
      +
      path - The path the entity is served on, with '/' as prefix
      +
      map - A map representing the content body (json)
      +
      Returns:
      +
      a result action that can be used for more checks
      +
      Throws:
      +
      Exception - throws exception if the request or a check fails
      +
      +
      +
      • +
    • +
      +

      perform_entity_patch

      +
      public org.springframework.test.web.servlet.ResultActions perform_entity_patch(String path, + T entity) + throws Exception
      +
      Perform a PATCH request with the (full) entity.
      +
      +
      Parameters:
      +
      path - The path the entity is served on, with '/' as prefix
      +
      entity - The entity to patch
      +
      Returns:
      +
      a result action that can be used for more checks
      +
      Throws:
      +
      Exception - throws exception if the request or a check fails
      +
      +
      +
      • +
    • +
      +

      perform_field_patch

      +
      public org.springframework.test.web.servlet.ResultActions perform_field_patch(String path, + String field, + String jsonValue) + throws Exception
      +
      Performs a patch on a single field on the provided path.
      +
      +
      Parameters:
      +
      path - The path the entity is served on, with '/' as prefix
      +
      field - the field that must be patched.
      +
      jsonValue - the patch value in json format. This means that when the value is a string you should add "".
      +
      Returns:
      +
      a ResultActions that can be used for additional checks
      +
      Throws:
      +
      Exception - throws exception if the request or a check fails
      +
      +
      +
      • +
    • +
      +

      string_to_contains_string

      +
      public org.springframework.test.web.servlet.ResultMatcher string_to_contains_string(String str)
      +
      Convert a String to a ResultMatcher that checks whether the string is contained in the result.
      +
      +
      Parameters:
      +
      str - the string we want to look for
      +
      Returns:
      +
      a result matcher that can be used to perform checks
      +
      +
      +
      • +
    • +
      +

      string_not_to_contains_string

      +
      public org.springframework.test.web.servlet.ResultMatcher string_not_to_contains_string(String str)
      +
      Convert a String to a ResultMatcher that checks whether + the string is not contained in the result.
      +
      +
      Parameters:
      +
      str - the string we want to look for
      +
      Returns:
      +
      a result matcher that can be used to perform checks
      +
      +
      +
      • +
    • +
      +

      string_contains_times_or_less

      +
      public org.springframework.test.web.servlet.ResultMatcher string_contains_times_or_less(String str, + int maxCount)
      +
      Creates a resultMatcher that checks if a string is contained a maximum of count times.
      +
      +
      Parameters:
      +
      str - the string that should be contained a limited amount of times
      +
      maxCount - the maximum amount of times the string can be contained. A count of maxCount is allowed
      +
      Returns:
      +
      a result matcher that can be used to perform a mex contains test
      +
      +
      +
      • +
    • +
      +

      string_not_empty

      +
      public org.springframework.test.web.servlet.ResultMatcher string_not_empty()
      +
      Get a ResultMatcher that checks whether the result is empty.
      +
      +
      Returns:
      +
      a result matcher that can be used to perform checks
      +
      +
      +
      • +
    • +
      +

      get_random_repository_entity

      +
      public T get_random_repository_entity()
      +
      Get a random entity from the repository.
      +
      +
      Returns:
      +
      a random entity.
      +
      +
      +
      • +
    • +
      +

      get_repository_entity_by_id

      +
      public T get_repository_entity_by_id(I id)
      +
      Get an entity by its id from the repository.
      +
      +
      Parameters:
      +
      id - the id of the entity to get
      +
      Returns:
      +
      the found entity
      +
      +
      +
      • +
    • +
      +

      save_repository_entity

      +
      public void save_repository_entity(T entity)
      +
      Save an entity to the repository.
      +
      +
      Parameters:
      +
      entity - entity to save
      +
      +
      +
      • +
    • +
      +

      delete_repository_entity

      +
      public void delete_repository_entity(T entity)
      +
      Delete an entity from the repository.
      +
      +
      Parameters:
      +
      entity - entity to delete
      +
      +
      +
      • +
    • +
      +

      repository_entity_exists

      +
      public boolean repository_entity_exists(T entity)
      +
      Check if the given entity exists.
      +
      +
      Parameters:
      +
      entity - entity to check existence of
      +
      Returns:
      +
      boolean whether the entity exists or not
      +
      +
      +
      • +
    +
    +
    • +
+
+ +
+
+
+ + diff --git a/documentation/backend/com/osoc6/OSOC6/Osoc6Application.html b/backend-java-api/com/osoc6/OSOC6/Osoc6Application.html similarity index 99% rename from documentation/backend/com/osoc6/OSOC6/Osoc6Application.html rename to backend-java-api/com/osoc6/OSOC6/Osoc6Application.html index a9ff314bc..84e47566f 100644 --- a/documentation/backend/com/osoc6/OSOC6/Osoc6Application.html +++ b/backend-java-api/com/osoc6/OSOC6/Osoc6Application.html @@ -1,7 +1,7 @@ - + - + Osoc6Application diff --git a/documentation/backend/com/osoc6/OSOC6/webhook/WebhookData.html b/backend-java-api/com/osoc6/OSOC6/Osoc6ApplicationTests.html similarity index 59% rename from documentation/backend/com/osoc6/OSOC6/webhook/WebhookData.html rename to backend-java-api/com/osoc6/OSOC6/Osoc6ApplicationTests.html index c5bc654fc..fcd9312f3 100644 --- a/documentation/backend/com/osoc6/OSOC6/webhook/WebhookData.html +++ b/backend-java-api/com/osoc6/OSOC6/Osoc6ApplicationTests.html @@ -1,22 +1,26 @@ - + - -WebhookData + +Osoc6ApplicationTests - + - - - - - - + + + + + + -