Web Script's Description...

개인적인 정리용으로...

출처: http://wiki.alfresco.com/wiki/Web_Scripts

기본

<br/> <webscript><br/> <shortname>Hello World</shortname><br/> <description>Greet a user</description><br/> <url>/helloworld?to={name?}</url><br/> <url>/hello/world?to={name?}</url><br/> <format default="html">extension</format><br/> <authentication>user</authentication><br/></webscript><br/>

• 
  
  shortname
  
  : 사람이 읽을 수 있는 Web Script 이름
  


• 
  
  description
  
  (선택적인): Web Script 설명
  


• 
  
  url
  
  (하나 혹은 여러 개): Web Script가 바인딩되는
  
  URI 템플릿
  
  .
  


• 
  
  format
  
  (선택적인): 응답의 content-type URI를 통해 어떻게 지정할 수 있는지를 제어
  




• 
  
  
  argument
  
  
  는 query string 파라미터로 content-type 을 지정
  




• 
  ex) /helloworld?to=dave&format=xml
  




• 
  
  
  extension
  
  
  은 URI extension 으로 content-type 을 지정
  




• 
  ex) /hello/world.xml?to=dave
  




• 
  
  
  any
  
  
  는 위의 둘 중 하나가 사용될 수 있음
  


• 
  지정되지 않으면 기본 값은
  
  
  any
  
  
  로 설정
  




• 
  
  authentication
  
  (선택적인): 인증 레벨이 필요할 경우 사용
  




• 
  
  
  none
  
  
  은 인증이 필요 없음을 지정
  


• 
  
  
  guest
  
  
  은 최소한 guest 인증을 필요로 함
  


• 
  
  
  user
  
  
  는 최소한 지정된 사용자 인증을 필요로 함
  


• 
  
  
  admin
  
  
  은 최소한 지정된 관리자 인증을 필요로 함
  

확장

<br/> <webscript kind="org.alfresco.httpsonly"> <br/> <shortname>Hello World</shortname><br/> <description>Greet a user</description><br/> <url>/sample/helloworld?to={name}</url><br/> <url>/sample/helloworld.xml?to={name}</url><br/> <format default="html">extension</format><br/> <lifecycle>sample</lifecycle><br/> <authentication runas="fred">user</authentication><br/> <transaction>required</transaction><br/> <family>Sample</family><br/> <cache><br/> <never>false</never><br/> <public>false</public><br/> <mustrevalidate/><br/> </cache><br/> <negotiate accept="text/html">html</negotiate><br/> <negotiate accept="text/xml">xml</negotiate><br/></webscript><br/>

• 
  
  transaction
  
  (선택적인): 트랜잭션 레벨을 지정
  




• 
  
  
  none
  
  
  은 트랜잭션이 필요 없음을 지정
  


• 
  
  
  required
  
  
  는 트랜잭션이 필요함을 지정
  


• 
  
  
  requiresnew
  
  
  는 새로운 트랜잭션이 필요함을 지정
  


• 
  지정되지 않으면 기본 값은
  
  
  none
  
  
  으로 설정
  




• 
  
  family
  
  (선택적인): 유사하거나 관련이 있는 web scripts 들을 분류하기 위한 태그
  


• 
  
  cache
  
  (선택적인): 캐싱 레벨을 지정
  




• 
  
  never
  
  (선택적인): 캐싱을 모두 적용해야 하는지 여부를 지정
  




• 
  
  
  true
  
  
  (기본 값) 는 web script 의 응답이 캐시되지 않음을 지정
  


• 
  
  
  false
  
  
  는 web script 의 응답이 캐시할 수 있음을 지정
  




• 
  
  public
  
  (선택적인): 인증 응답이 공개 캐시에 캐시해야 하는지 여부를 지정
  




• 
  
  
  true
  
  
  (기본 값) /
  
  
  false
  
  
  




• 
  
  mustrevalidate
  
  (선택적인): 캐시가 freshness 를 보장하기 위해 web scritp 응답의 버전을 재검증해야 하는지 여부를 지정
  




• 
  
  
  true
  
  
  (기본 값) /
  
  
  false
  
  
  






• 
  
  negotiate
  
  (0개 이상): Accept 헤더 MIME-type 과 응답의 특정 web script 형식의 연관
  


• 
  
  kind
  
  (선택적인):
  
  web script 의 종류
  
  재정의를 위한 식별
  


• 
  
  lifecycle
  
  (선택적인):
  
  web script 의 라이프사이클
  
  을 지정
  




• 
  
  
  none
  
  
  은 web script 가 라이프사이클의 일부가 아님을 지정
  


• 
  
  
  sample
  
  
  은 web script 가 샘플로 만들어졌으며, 제품으로 사용하지 않음을 지정
  


• 
  
  
  draft
  
  
  는 web script 가 실험 중이거나 변경/정지 될 수 있음을 지정
  


• 
  
  
  public_api
  
  
  는 Alfresco 의 공개 API 이며, 안정적이고 잘 테스트되었음을 지정
  


• 
  
  
  draft_public_api
  
  
  는 공개 API가 될 것이지만, 실험 중이거나 변경/정지 될 수 있음을 지정
  


• 
  
  
  deprecated
  
  
  는 향후 버전에서 제거될 수 있으니 사용을 피하도록 함을 지정
  


• 
  
  
  internal
  
  
  은 Alfresco 내부에서만 사용됨을 지정