This is the server side of the Accessibility Support Database offering CRUD REST Services to the front end. Project page: http://www.w3.org/WAI/ACT/

• REST API
  • TestingSession
    • TestingSession#save
    • TestingSession#getSession
    • TestingSession#login
    • TestingSession#logout
    • TestingSession#persist
  • Profile
    • Profile#insertUserProfile
    • Profile#updateUserProfile
    • Profile#deleteUserProfile
    • Profile#findByUserId
    • Profile#getAssistiveTechnologies
    • Profile#getPlatforms
    • Profile#getUserAgents
    • Profile#getPlugins
    • Profile#findByProfileId
  • Test
    • Test#findAll
    • Test#findById
    • Test#findByTechnique
    • Test#getTestsTreeData
    • Test#getTestAsXml
    • Test#updateTestFromXml
    • Test#deleteTest
    • Test#updateTest
    • Test#deleteResourceFile
    • Test#testPersist
  • Query
    • Query#findByQuery
  • WCAG2
    • WCAG2#getWCAG2TreeData
    • WCAG2#getWebtechsTreeData
    • WCAG2#getWebTechnologiesWithTechniquesTreeData
    • WCAG2#findTechniquesByWebTechNameId
    • WCAG2#getAllTechniques
    • WCAG2#getTechniqueById
    • WCAG2#getTechniqueByTerm
    • WCAG2#getAllPrinciples
    • WCAG2#getAllGuidelines
    • WCAG2#getAllSuccessCriteria
  • Testresult
    • Testresult#findById
    • Testresult#filter
    • Testresult#saveBunch
    • Testresult#getATTree
    • Testresult#getUATree
    • Testresult#getOSTree
    • Testresult#findByFilterTestResultTechniqueOveview
    • Testresult#findByFilterTestResultTestOveview
  • Admin
  • AdminTechniques
  • Rating
  • Data Types
• Key Technologies
• Config
• Build
  • Prerequisites
  • Process
• Deploy
  • Prerequisites
  • Process
• TODO

See Javascript implemention of the REST API: https://github.com/w3c/wai-axsdb-web/blob/master/js/API.js

Response Status: http://docs.oracle.com/javaee/6/api/javax/ws/rs/core/Response.Status.html In addition there is also a developer workbench for allowing developers to experiment with the data and the API functionality.

AxsdbQL --> HQL like .. explain

Provides functionality for managing a user session like login, logout etc. The session is saved client side by combining sessionStorage and cookies but also server side.

Add a session to the server side session pool. If there is no session id an id is being generated

• URL: testingsession/commit
• Method: POST
• Request Data Type: TestingSession
• Response HTTP Status: OK | NOT_MODIFIED
• Response Entity: TestingSession

Gets a session object by session id or create a new of not exists.

• URL: testingsession/browse/{sessionid}
• Method: GET
• Request Data Type: Null
• Response HTTP Status: OK | CREATED
• Response Entity: TestingSession

Authentication / Authorization of the session

• URL: testingsession/login
• Method: POST
• Request Data Type: LoginData: {userId:"", pass: "", sessionId=""}
• Response HTTP Status: OK | FORBIDDEN
• Response Entity: TestingSession (with userid and roles)

Session log out

• URL: testingsession/logout/{sessionId}
• Method: POST
• Request Data Type: Null
• Response HTTP Status: OK
• Response Entity: Null

Given a session, this persists the content (test results, [TODO: search filters]) in the database.

• URL: testingsession/commit/persist/{sessionId}
• Method: POST
• Request Data Type: Null
• Response HTTP Status: OK | NOT_MODIFIED
• Response Entity: TestingSession

Provides functionality for managing Testing Profiles

Inserts in database a testing profile for the specific user

• URL: profile/{userId}/{sessionId}
• Method: POST
• Request Data Type: UserTestingProfile
• Response HTTP Status: CREATED | NOT_MODIFIED | UNAUTHORIZED
• Response Entity: profileId

Updates in database a testing profile for the specific user

• URL: profile/put/{sessionId}
• Method: POST
• Request Data Type: UserTestingProfile
• Response HTTP Status: CREATED | NOT_MODIFIED | UNAUTHORIZED
• Response Entity: profileId

Deletes in database a testing profile for the specific user

• URL: profile/{pid}/{sessionId}
• Method: DELETE
• Request Data Type: Null
• Response HTTP Status: CREATED=200 | NOT_FOUND=404 | NOT_MODIFIED | UNAUTHORIZED
• Response Entity: profileId

Get Profiles By UserId

• URL: profile/{userId}/{sessionId}
• Method: POST
• Request Data Type:
• Response HTTP Status: OK | UNAUTHORIZED
• Response Entity :List of UserTestingProfile

Retrieve unique AssistiveTechnologies in existing testing profiles by term

• URL: profile/browse/ATs/{term}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : List of AssistiveTechnology

Retrieve unique Platforms (OSs) in existing testing profiles by term

• URL: profile/browse/platforms/{term}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : List of Platform

Retrieve unique User Agents (browsers) in existing testing profiles by term

• URL: profile/browse/UAs/{term}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : List of UserAgent

Retrieve unique Plugins in existing testing profiles by term

• URL: profile/browse/Plugins/{term}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : List of Plugin

Retrieve testing profile by id

• URL:profile/browse/{profileId}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : TestingProfile | Null

Provides functionality for managing the tests like saving new, editing etc.

Finds all Tests

• URL:test
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : {entities: [Test]}

Finds an existing Test by testUnitId

• URL:test/{testUnitId}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK | NOT_FOUND=404
• Response Entity : Test || Null

Finds Tests by Technique Id

• URL:test/byTechnique/{tid}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : {entities: [Test]}

Get TreeNodeData with Tests based on Filter

• URL:test/tree
• Method: GET
• Request Data Type: filter
• Response HTTP Status: OK
• Response Entity : treeNodeData

Get Test as XML by testUnitId

• URL:test/xml/{id}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : XML as text

Update Test from XML

• URL:test/xml/{sessionId}
• Method: POST
• Request Data Type: Test
• Response HTTP Status: OK | NOT_MODIFIED | NOT_ACCEPTABLE | UNAUTHORIZED
• Response Entity : Test

Deletes Test by id

• URL:test/{sessionId}/{id}
• Method: DELETE
• Request Data Type:
• Response HTTP Status: OK | NOT_MODIFIED | NOT_ACCEPTABLE | UNAUTHORIZED
• Response Entity :

Updates a test

• URL:test/status/{sessionId}
• Method: POST
• Request Data Type: Test
• Response HTTP Status: OK | NOT_MODIFIED | UNAUTHORIZED
• Response Entity : Test

Deletes a resource file of a Test

• URL:test/resource/{sessionId}/{testUnitId}/{fileId}
• Method: DELETE
• Request Data Type:
• Response HTTP Status: OK | NOT_MODIFIED | UNAUTHORIZED
• Response Entity :

Saves a test posted by a form. See config file (FORM_TESTUNIT_FORMFIELD_TESTUNITDESCRIPTION, FORM_TESTUNIT_FORMFIELD_CODE,FORM_TESTUNIT_FORMFIELD_TESTFILE). See more in config section

• URL:test/commit/{sessionId}
• Method: POST
• Request Data Type: HttpServletRequest (Form Post [TODO: explain])
• Response HTTP Status: CREATED | NOT_MODIFIED | UNAUTHORIZED
• Response Entity : testUnitId

Provides a way of read only querying the database. Here AxsDB select only HQL queries can be executed

This is the general Query method.

• URL:query/{q}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : {entities : [entity]}

Provides functionality for getting information about testing requirements including WCAG Principles Guidelines, Success Criteria, HTML techniques, CSS techniques etc.

Get the WCAG2 Principles/geuidelines/SuccessCriteria TreeNodeData given the conformance level (A | AA | AAA)

• URL:wcag2/browse/wcag2/tree/{level}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : TreeNodeData

Get the Web Technologies (Technologies Techniques) TreeNodeData

• URL:wcag2/browse/webtechs/tree
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : TreeNodeData

Get the Web Technologies (Technologies Techniques) TreeNodeData

• URL:wcag2/browse/webtechswithtechniques/tree
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : TreeNodeData

Get the Techniques by web technology name id (e.g WCAG20-ARIA-TECHS)

• URL:wcag2/techniques/{nameId}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : {entities: [Technique]}

Get the Techniques by web technology name id (e.g WCAG20-ARIA-TECHS)

• URL:wcag2/techniques
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : {entities: [Technique]}

Get Technique by DB id

• URL:wcag2/technique/byid/{id}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : {entities: [Technique]}

Get Technique by term

• URL:wcag2/technique/byid/{id}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : List of Techniques

Get All Principles

• URL:wcag2/principles
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : List of Principles

Get All Guidelines

• URL:wcag2/guidelines
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : List of Guidelines

Get All Principles

• URL:wcag2/criteria
• Method: GET
• Request Data Type:
• Response HTTP Status: OK
• Response Entity : List of SuccessCriteria

Provides functionality for managing the Test Results

Find a testresult by DB id

• URL: testresult/{id}
• Method: GET
• Request Data Type:
• Response HTTP Status: OK | NOT_FOUND | BAD_REQUEST
• Response Entity : TestResult | id

Find test results based on filter

• URL: testresult/filter
• Method: POST
• Request Data Type: Filter
• Response HTTP Status: OK
• Response Entity : List of TestResult

Save a bunch of test results

• URL: testresult/commit/bunch
• Method: PoST
• Request Data Type: TestResultsBunch
• Response HTTP Status: OK | NO_CONTENT | NOT_MODIFIED
• Response Entity : TestResultsBunch ID

Get unique Assistive Technologies as TreeDataNode that appear in test results in DB based on the given filter

• URL: testresult/browse/at/tree
• Method: PoST
• Request Data Type: Filter
• Response HTTP Status: OK
• Response Entity : treeNodeData

Get unique User Agents (Browsers) as TreeDataNode that appear in test results in DB based on the given filter

• URL: testresult/browse/ua/tree
• Method: PoST
• Request Data Type: Filter
• Response HTTP Status: OK
• Response Entity : treeNodeData

Get unique Platforms (Operating Systems) as TreeDataNode that appear in test results in DB based on the given filter

• URL: testresult/browse/oa/tree
• Method: PoST
• Request Data Type: Filter
• Response HTTP Status: OK
• Response Entity : treeNodeData

Top level results view: by technique overall pass and fail

• URL: testresult/browse/bytechnique/overview
• Method: PoST
• Request Data Type: Filter
• Response HTTP Status: OK
• Response Entity : [TestResultDataOverview]

Second level results view: by Test of specific technique overall pass and fail

• URL: testresult/browse/bytest/overview/{techNameId}
• Method: PoST
• Request Data Type: Filter
• Response HTTP Status: OK
• Response Entity : [TestResultTestOveview]

Provides functionality for managing any rating (test case or test result)

  testingSession : {
      sessionName: null,
      sessionId: null, 
      testProfileId: "-1",
      testUnitIdList: [],
      testResultList: [],
      ratings: [],
      currentTestUnitId: "-1",
      userTestingProfiles: [],
      userId: null,
      userRoles: [],
      lastTestUnit: null,       
      pCounter: -10
  }
  
  filter : {
        page : "",
        userName : null,
        lastModified: "",
        criteriosLevel : "AAA",
        criterios : [],
        technologies : [],
        ats : [],
        uas : [],
        oss : []
    };
    
   treeNodeData : {
        label:"ROOT",
        children:[TreeData],
        value:null,
        selected:false,
        disabled:false,
        subselector:true,
        selectable:true,
        collapsed:true,
        type:"type of data",
        description:null,
        noOfChildren:0
   }

 test: {
    "testUnitId":"ARIA1_0000001",
    "title":"ertert",
    "description":"ertert",
    "status":"unconfirmed",
    "creator":"evlachog",
    "version":"0.1",
    "date":"2014-04-23 11:45:40",
    "technique":{
       "id":1,
       "nameId":"ARIA1",
       "specRef":"https://raw.github.com/w3c/wcag/Working-Branch-for-Fall-2014/wcag20/sources/techniques/aria/ARIA1.xml",
       "title":"Using the aria-describedby property to provide a descriptive label for user interface controls",
       "webTechnology":"WCAG20-ARIA-TECHS",
       "status":1,
       "lastModified":"2014-03-28T17:18:24.000+0000",
       "sha":"90d1c1c3fdf2a793a0c93cc5408c53b913ddd1a7"
    },
    "subject":{
       "testFile":{
          "id":2,
          "mediatype":null,
          "src":"ARIA1_0000001.html"
       },
       "resources":[]
    },
    "testProcedure":{
       "yesNoQuestion":"ertret",
       "expectedResult":true,
       "steps":[
          {
             "step":"ertert",
             "orderId":0,
             "id":1
          }
       ]
    },
    "comment":"ertre",
    "id":1,
    "language":"en"
 }

 testResultDataOverview : {
    technique:"", 
    techiqueTitle:"", 
    noOfPass:"", 
    noOfFail:""
   }
   
 TestResultTestOveview: {
    testUnitId:"", 
    testTitle:"", 
    noOfPass:"", 
    noOfFail:""
 }

• JAVA
• JPA
• Hibernate
• Mysql
• RestEasy

TODO

• JKD 1.6+ (1.7+ recommended)
• apache maven 2+

• mvn -Dmaven.test.skip=true install

• apache ant

• cp build.default.properties ../build.properties
• edit build.properties
• ant upload
• ssh serverHost
• cd install.dir
• ant deploy-all
• java container restart
• Apache proxy config if required
• Apache restart

• create test files folder
• create log folder
• config files